广告位联系
返回顶部
分享到

spring常用注解开发一个RESTful接口

java 来源:互联网 作者:秩名 发布时间:2022-03-17 21:38:49 人浏览
摘要

第一步:定义资源(对象) 1 2 3 4 5 6 7 8 9 10 @Data @Builder public class Article { private Long id; private String author; private String title; private String content; private Date createTime; private ListReader reader; } 1 2

第一步:定义资源(对象)

1

2

3

4

5

6

7

8

9

10

@Data

@Builder

public class Article {

    private Long  id;

    private String author;

    private String title;

    private String content;

    private Date createTime;

    private List<Reader> reader;

}

1

2

3

4

5

@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,届时会做补充。

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

@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变量打印日志。不需要写下面的这行代码。

1

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

二、统一规范接口响应的数据格式

下面这个类是用于统一数据响应接口标准的。它的作用是:统一所有开发人员响应前端请求的返回结果格式,减少前后端开发人员沟通成本,是一种RESTful接口标准化的开发约定。下面代码只对请求成功的情况进行封装,在后续的异常处理相关的章节会做更加详细的说明。

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

@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;

  }

}


版权声明 : 本文内容来源于互联网或用户自行发布贡献,该文观点仅代表原作者本人。本站仅提供信息存储空间服务和不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权, 违法违规的内容, 请发送邮件至2530232025#qq.cn(#换@)举报,一经查实,本站将立刻删除。
原文链接 : https://www.kancloud.cn/hanxt/springboot2/1384776
相关文章
  • SpringBoot自定义错误处理逻辑介绍

    SpringBoot自定义错误处理逻辑介绍
    1. 自定义错误页面 将自定义错误页面放在 templates 的 error 文件夹下,SpringBoot 精确匹配错误信息,使用 4xx.html 或者 5xx.html 页面可以打印错误
  • Java实现手写一个线程池的代码

    Java实现手写一个线程池的代码
    线程池技术想必大家都不陌生把,相信在平时的工作中没有少用,而且这也是面试频率非常高的一个知识点,那么大家知道它的实现原理和
  • Java实现断点续传功能的代码

    Java实现断点续传功能的代码
    题目实现:网络资源的断点续传功能。 二、解题思路 获取要下载的资源网址 显示网络资源的大小 上次读取到的字节位置以及未读取的字节
  • 你可知HashMap为什么是线程不安全的
    HashMap 的线程不安全 HashMap 的线程不安全主要体现在下面两个方面 在 jdk 1.7 中,当并发执行扩容操作时会造成环形链和数据丢失的情况 在
  • ArrayList的动态扩容机制的介绍

    ArrayList的动态扩容机制的介绍
    对于 ArrayList 的动态扩容机制想必大家都听说过,之前的文章中也谈到过,不过由于时间久远,早已忘却。 所以利用这篇文章做做笔记,加
  • JVM基础之字节码的增强技术介绍

    JVM基础之字节码的增强技术介绍
    字节码增强技术 在上文中,着重介绍了字节码的结构,这为我们了解字节码增强技术的实现打下了基础。字节码增强技术就是一类对现有字
  • Java中的字节码增强技术

    Java中的字节码增强技术
    1.字节码增强技术 字节码增强技术就是一类对现有字节码进行修改或者动态生成全新字节码文件的技术。 参考地址 2.常见技术 技术分类 类
  • Redis BloomFilter布隆过滤器原理与实现

    Redis BloomFilter布隆过滤器原理与实现
    Bloom Filter 概念 布隆过滤器(英语:Bloom Filter)是1970年由一个叫布隆的小伙子提出的。它实际上是一个很长的二进制向量和一系列随机映射
  • Java C++算法题解leetcode801使序列递增的最小交换次

    Java C++算法题解leetcode801使序列递增的最小交换次
    题目要求 思路:状态机DP 实现一:状态机 Java 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 class Solution { public int minSwap(int[] nums1, int[] nums2) { int n
  • Mybatis结果集映射与生命周期介绍

    Mybatis结果集映射与生命周期介绍
    一、ResultMap结果集映射 1、设计思想 对简单的语句做到零配置,对于复杂一点的语句,只需要描述语句之间的关系就行了 2、resultMap的应用场
  • 本站所有内容来源于互联网或用户自行发布,本站仅提供信息存储空间服务,不拥有版权,不承担法律责任。如有侵犯您的权益,请您联系站长处理!
  • Copyright © 2017-2022 F11.CN All Rights Reserved. F11站长开发者网 版权所有 | 苏ICP备2022031554号-1 | 51LA统计