spring常用注解開發(fā)一個(gè)RESTful接口示例

更新時(shí)間：2022年03月17日 17:30:52 作者：字母哥

這篇文章主要為大家介紹了使用spring常用注解開發(fā)一個(gè)RESTful接口示例，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步

一、開發(fā)REST接口

在本專欄之前的章節(jié)中已經(jīng)給大家介紹了

Spring常用注解及http數(shù)據(jù)轉(zhuǎn)換教程

Spring Boot提高開發(fā)效率必備工具lombok使用

Spring Boot開發(fā)RESTful接口與http協(xié)議狀態(tài)表述

本節(jié)內(nèi)容就是將之前學(xué)到的內(nèi)容以代碼的方式體現(xiàn)出來。

第一步：定義資源（對象）

@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提供給我們的注解，有利于我們簡化代碼?？梢詤⒖急緦谥罢鹿?jié)對lombok進(jìn)行學(xué)習(xí)。

@Builder為我們提供了通過對象屬性的鏈?zhǔn)劫x值構(gòu)建對象的方法，下文中代碼會有詳細(xì)介紹。

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

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

我們實(shí)現(xiàn)一個(gè)簡單的RESTful接口

增加一篇Article ，使用POST方法
刪除一篇Article，使用DELETE方法，參數(shù)是id
更新一篇Article，使用PUT方法，以id為主鍵進(jìn)行更新
獲取一篇Article，使用GET方法

下面代碼中并未真正的進(jìn)行數(shù)據(jù)庫操作，本專欄后面會講解mybatis和JPA，屆時(shí)會做補(bǔ)充。

@Slf4j
@RestController
@RequestMapping("/rest")
public class ArticleController {
  //獲取一篇Article，使用GET方法,根據(jù)id查詢一篇文章
  //@RequestMapping(value = "/articles/{id}",method = RequestMethod.GET)
  @GetMapping("/articles/{id}")
  public AjaxResponse getArticle(@PathVariable("id") Long id){
    //使用lombok提供的builder構(gòu)建對象
    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方式接收參數(shù))
  //@RequestMapping(value = "/articles",method = RequestMethod.POST)
  @PostMapping("/articles")
  public AjaxResponse saveArticle(@RequestBody Article article,
                                  @RequestHeader String aaa){
    //因?yàn)槭褂昧薼ombok的Slf4j注解，這里可以直接使用log變量打印日志
    log.info("saveArticle:" + article);
    return AjaxResponse.success();
  }
  //增加一篇Article ，使用POST方法(RequestParam方式接收參數(shù))
  /*@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為主鍵進(jìn)行更新
  //@RequestMapping(value = "/articles",method = RequestMethod.PUT)
  @PutMapping("/articles")
  public AjaxResponse updateArticle(@RequestBody Article article){
    if(article.getId() == null){
      //article.id是必傳參數(shù)，因?yàn)橥ǔ８鶕?jù)id去修改數(shù)據(jù)
      //TODO 拋出一個(gè)自定義的異常
    }
    log.info("updateArticle:" + article);
    return AjaxResponse.success();
  }
  //刪除一篇Article，使用DELETE方法，參數(shù)是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();
  }
}

因?yàn)槭褂昧薼ombok的@Slf4j注解（類的定義處），就可以直接使用log變量打印日志。不需要寫下面的這行代碼。

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

二、統(tǒng)一規(guī)范接口響應(yīng)的數(shù)據(jù)格式

下面這個(gè)類是用于統(tǒng)一數(shù)據(jù)響應(yīng)接口標(biāo)準(zhǔn)的。它的作用是：統(tǒng)一所有開發(fā)人員響應(yīng)前端請求的返回結(jié)果格式，減少前后端開發(fā)人員溝通成本，是一種RESTful接口標(biāo)準(zhǔn)化的開發(fā)約定。下面代碼只對請求成功的情況進(jìn)行封裝，在后續(xù)的異常處理相關(guān)的章節(jié)會做更加詳細(xì)的說明。

@Data
public class AjaxResponse {
  private boolean isok;  //請求是否處理成功
  private int code; //請求響應(yīng)狀態(tài)碼（200、400、500）
  private String message;  //請求結(jié)果描述信息
  private Object data; //請求結(jié)果數(shù)據(jù)（通常用于查詢操作）
  private AjaxResponse(){}
  //請求成功的響應(yīng)，不帶查詢數(shù)據(jù)（用于刪除、修改、新增接口）
  public static AjaxResponse success(){
    AjaxResponse ajaxResponse = new AjaxResponse();
    ajaxResponse.setIsok(true);
    ajaxResponse.setCode(200);
    ajaxResponse.setMessage("請求響應(yīng)成功!");
    return ajaxResponse;
  }
  //請求成功的響應(yīng)，帶有查詢數(shù)據(jù)（用于數(shù)據(jù)查詢接口）
  public static AjaxResponse success(Object obj){
    AjaxResponse ajaxResponse = new AjaxResponse();
    ajaxResponse.setIsok(true);
    ajaxResponse.setCode(200);
    ajaxResponse.setMessage("請求響應(yīng)成功!");
    ajaxResponse.setData(obj);
    return ajaxResponse;
  }
  //請求成功的響應(yīng)，帶有查詢數(shù)據(jù)（用于數(shù)據(jù)查詢接口）
  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常用注解開發(fā)一個(gè)RESTful接口示例的詳細(xì)內(nèi)容，更多關(guān)于springboot注解開發(fā)RESTful接口的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: