最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

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

 更新時間:2022年03月17日 17:30:52   作者:字母哥  
這篇文章主要為大家介紹了使用spring常用注解開發(fā)一個RESTful接口示例,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步

一、開發(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進行學(xué)習(xí)。

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

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

第二步:HTTP方法與Controller(動作)

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

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

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

@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){
    //因為使用了lombok的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為主鍵進行更新
  //@RequestMapping(value = "/articles",method = RequestMethod.PUT)
  @PutMapping("/articles")
  public AjaxResponse updateArticle(@RequestBody Article article){
    if(article.getId() == null){
      //article.id是必傳參數(shù),因為通常根據(jù)id去修改數(shù)據(jù)
      //TODO 拋出一個自定義的異常
    }
    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();
  }
}

因為使用了lombok的@Slf4j注解(類的定義處),就可以直接使用log變量打印日志。不需要寫下面的這行代碼。

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

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

下面這個類是用于統(tǒng)一數(shù)據(jù)響應(yīng)接口標(biāo)準(zhǔn)的。它的作用是:統(tǒng)一所有開發(fā)人員響應(yīng)前端請求的返回結(jié)果格式,減少前后端開發(fā)人員溝通成本,是一種RESTful接口標(biāo)準(zhǔn)化的開發(fā)約定。下面代碼只對請求成功的情況進行封裝,在后續(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ā)一個RESTful接口示例的詳細(xì)內(nèi)容,更多關(guān)于springboot注解開發(fā)RESTful接口的資料請關(guān)注腳本之家其它相關(guān)文章!

相關(guān)文章

  • java不用循環(huán)語句打印數(shù)組元素的實例

    java不用循環(huán)語句打印數(shù)組元素的實例

    下面小編就為大家?guī)硪黄猨ava不用循環(huán)語句打印數(shù)組元素的實例。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧
    2017-03-03
  • 關(guān)于Struts2文件上傳與自定義攔截器

    關(guān)于Struts2文件上傳與自定義攔截器

    本篇文章,小編將為大家介紹關(guān)于Struts2文件上傳與自定義攔截器,有需要的朋友可以參考一下
    2013-04-04
  • Spring Boot 使用 Swagger 構(gòu)建 RestAPI 接口文檔

    Spring Boot 使用 Swagger 構(gòu)建 RestAPI 接口文檔

    這篇文章主要介紹了Spring Boot 使用 Swagger 構(gòu)建 RestAPI 接口文檔,幫助大家更好的理解和使用Spring Boot框架,感興趣的朋友可以了解下
    2020-10-10
  • 利用java生成二維碼工具類示例代碼

    利用java生成二維碼工具類示例代碼

    二維碼對現(xiàn)在的人們來說再熟悉不過了,我們在開發(fā)的時候也經(jīng)常會用到二維碼,下面這篇文章主要給大家介紹了關(guān)于利用java生成二維碼工具類的相關(guān)資料,文中給了詳細(xì)的示例代碼,需要的朋友可以參考借鑒,下面來一起看看吧。
    2017-09-09
  • Java RandomAccessFile基本文件操作示例

    Java RandomAccessFile基本文件操作示例

    這篇文章主要介紹了Java RandomAccessFile基本文件操作,結(jié)合實例形式分析了Java基于RandomAccessFile實現(xiàn)文件讀寫及文件隨機訪問相關(guān)操作技巧,需要的朋友可以參考下
    2019-09-09
  • Java使用Lua實現(xiàn)動態(tài)擴展和腳本自動升級

    Java使用Lua實現(xiàn)動態(tài)擴展和腳本自動升級

    Lua是一種輕量級的腳本語言,常用于游戲開發(fā)和嵌入式系統(tǒng)中,這篇文章主要介紹了Java如何調(diào)用Lua實現(xiàn)動態(tài)擴展和腳本自動升級,感興趣的可以學(xué)習(xí)下
    2023-08-08
  • Java使用JaCoCo進行代碼覆蓋率分析的操作指南

    Java使用JaCoCo進行代碼覆蓋率分析的操作指南

    JaCoCo是一個開源的 Java 代碼覆蓋率工具,廣泛應(yīng)用于測試過程中,它可以幫助開發(fā)者分析測試代碼的覆蓋情況,在本文中,我們將介紹 JaCoCo 的基本功能、如何集成到 Maven 項目中,以及通過具體案例展示如何生成覆蓋率報告,需要的朋友可以參考下
    2025-02-02
  • Spring中事務(wù)管理方案和事務(wù)管理器及事務(wù)控制的API詳解

    Spring中事務(wù)管理方案和事務(wù)管理器及事務(wù)控制的API詳解

    這篇文章主要介紹了Spring中事務(wù)管理方案和事務(wù)管理器及事務(wù)控制的API詳解,事務(wù)管理是指對事務(wù)進行管理和控制,以確保事務(wù)的正確性和完整性,事務(wù)管理的作用是保證數(shù)據(jù)庫的數(shù)據(jù)操作的一致性和可靠性,需要的朋友可以參考下
    2023-08-08
  • Java工廠模式之簡單工廠,工廠方法,抽象工廠模式詳解

    Java工廠模式之簡單工廠,工廠方法,抽象工廠模式詳解

    這篇文章主要為大家詳細(xì)介紹了Java工廠模式之簡單工廠、工廠方法、抽象工廠模式,文中示例代碼介紹的非常詳細(xì),具有一定的參考價值,感興趣的小伙伴們可以參考一下,希望能夠給你帶來幫助
    2022-02-02
  • quartz實現(xiàn)定時功能實例詳解(servlet定時器配置方法)

    quartz實現(xiàn)定時功能實例詳解(servlet定時器配置方法)

    Quartz是一個完全由java編寫的開源作業(yè)調(diào)度框架,下面提供一個小例子供大家參考,還有在servlet配置的方法
    2013-12-12

最新評論

剑河县| 桦川县| 陆川县| 从江县| 正蓝旗| 延庆县| 沿河| 信宜市| 朝阳县| 西畴县| 临泉县| 江达县| 库伦旗| 柏乡县| 上饶市| 徐水县| 穆棱市| 宁明县| 含山县| 阿城市| 得荣县| 河东区| 唐山市| 临朐县| 筠连县| 新平| 周宁县| 雅江县| 巴里| 缙云县| 宜都市| 罗平县| 玛纳斯县| 湖口县| 巨鹿县| 山阳县| 元江| 仁化县| 岳阳市| 贵定县| 余姚市|