spring常用註解開發一個RESTful介面範例

2022-03-17 19:00:13

一、開發REST介面

在本專欄之前的章節中已經給大家介紹了

本節內容就是將之前學到的內容以程式碼的方式體現出來。

第一步：定義資源（物件）

@Data
@Builder
public class Article {
    private Long  id;
    private String author;
    private String title;
    private String content;
    private Date createTime;
    private List<Reader> reader;
}

@Data
public class Reader {
  private String name;
  private Integer age;
}

Data、Builder都是lombok提供給我們的註解，有利於我們簡化程式碼。可以參考本專欄之前章節對lombok進行學習。

@Builder為我們提供了通過物件屬性的鏈式賦值構建物件的方法，下文中程式碼會有詳細介紹。

@Data註解幫我們定義了一系列常用方法，如：getters、setters、hashcode、equals等

第二步：HTTP方法與Controller（動作）

我們實現一個簡單的RESTful介面

增加一篇Article ，使用POST方法
刪除一篇Article，使用DELETE方法，引數是id
更新一篇Article，使用PUT方法，以id為主鍵進行更新
獲取一篇Article，使用GET方法

下面程式碼中並未真正的進行資料庫操作，本專欄後面會講解mybatis和JPA，屆時會做補充。

@Slf4j
@RestController
@RequestMapping("/rest")
public class ArticleController {
  //獲取一篇Article，使用GET方法,根據id查詢一篇文章
  //@RequestMapping(value = "/articles/{id}",method = RequestMethod.GET)
  @GetMapping("/articles/{id}")
  public AjaxResponse getArticle(@PathVariable("id") Long id){
    //使用lombok提供的builder構建物件
    Article article = Article.builder()
            .id(id)
            .author("zimug")
            .content("spring boot 從青銅到王者")
            .createTime(new Date())
            .title("t1").build();
    log.info("article:" + article);
    return AjaxResponse.success(article);
  }
  //增加一篇Article ，使用POST方法(RequestBody方式接收引數)
  //@RequestMapping(value = "/articles",method = RequestMethod.POST)
  @PostMapping("/articles")
  public AjaxResponse saveArticle(@RequestBody Article article,
                                  @RequestHeader String aaa){
    //因為使用了lombok的Slf4j註解，這裡可以直接使用log變數列印紀錄檔
    log.info("saveArticle:" + article);
    return AjaxResponse.success();
  }
  //增加一篇Article ，使用POST方法(RequestParam方式接收引數)
  /*@PostMapping("/articles")
  public AjaxResponse saveArticle(@RequestParam  String author,
                                  @RequestParam  String title,
                                  @RequestParam  String content,
                                  @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
                                  @RequestParam  Date createTime){
    log.info("saveArticle:" + createTime);
    return AjaxResponse.success();
  }*/
  //更新一篇Article，使用PUT方法，以id為主鍵進行更新
  //@RequestMapping(value = "/articles",method = RequestMethod.PUT)
  @PutMapping("/articles")
  public AjaxResponse updateArticle(@RequestBody Article article){
    if(article.getId() == null){
      //article.id是必傳引數，因為通常根據id去修改資料
      //TODO 丟擲一個自定義的異常
    }
    log.info("updateArticle:" + article);
    return AjaxResponse.success();
  }
  //刪除一篇Article，使用DELETE方法，引數是id
  //@RequestMapping(value = "/articles/{id}",method = RequestMethod.DELETE)
  @DeleteMapping("/articles/{id}")
  public AjaxResponse deleteArticle(@PathVariable("id") Long id){
    log.info("deleteArticle:" + id);
    return AjaxResponse.success();
  }
}

因為使用了lombok的@Slf4j註解（類的定義處），就可以直接使用log變數列印紀錄檔。不需要寫下面的這行程式碼。

private static final Logger log = LoggerFactory.getLogger(HelloController.class);

二、統一規範介面響應的資料格式

下面這個類是用於統一資料響應介面標準的。它的作用是：統一所有開發人員響應前端請求的返回結果格式，減少前後端開發人員溝通成本，是一種RESTful介面標準化的開發約定。下面程式碼只對請求成功的情況進行封裝，在後續的例外處理相關的章節會做更加詳細的說明。

@Data
public class AjaxResponse {
  private boolean isok;  //請求是否處理成功
  private int code; //請求響應狀態碼（200、400、500）
  private String message;  //請求結果描述資訊
  private Object data; //請求結果資料（通常用於查詢操作）
  private AjaxResponse(){}
  //請求成功的響應，不帶查詢資料（用於刪除、修改、新增介面）
  public static AjaxResponse success(){
    AjaxResponse ajaxResponse = new AjaxResponse();
    ajaxResponse.setIsok(true);
    ajaxResponse.setCode(200);
    ajaxResponse.setMessage("請求響應成功!");
    return ajaxResponse;
  }
  //請求成功的響應，帶有查詢資料（用於資料查詢介面）
  public static AjaxResponse success(Object obj){
    AjaxResponse ajaxResponse = new AjaxResponse();
    ajaxResponse.setIsok(true);
    ajaxResponse.setCode(200);
    ajaxResponse.setMessage("請求響應成功!");
    ajaxResponse.setData(obj);
    return ajaxResponse;
  }
  //請求成功的響應，帶有查詢資料（用於資料查詢介面）
  public static AjaxResponse success(Object obj,String message){
    AjaxResponse ajaxResponse = new AjaxResponse();
    ajaxResponse.setIsok(true);
    ajaxResponse.setCode(200);
    ajaxResponse.setMessage(message);
    ajaxResponse.setData(obj);
    return ajaxResponse;
  }
}

以上就是springboot常用註解開發一個RESTful介面範例的詳細內容，更多關於springboot註解開發RESTful介面的資料請關注it145.com其它相關文章！

spring常用註解開發一個RESTful介面範例

目錄

一、開發REST介面

第一步：定義資源（物件）

第二步：HTTP方法與Controller（動作）

二、統一規範介面響應的資料格式

熱門文章