前言:一个纯粹的或者这样说一个简洁的spring boot项目注解是很重要的,可以更加快速的开发。。

controller层注解

  1. @RestController
    • 注解作用:直接把实体当做json对象,返回到前端
    • 定义范围:这个是加在类上的
  2. @RequestMapping
    • 注解作用:映射请求路径
    • 定义范围:加在类上可以设置请求映射的固定格式,加在方法上,可以设置这个方法所对应的请求映射,方法上可以设置请求方法使用method参数,注意,要加个value参数,设置映射路径
    • 注意情况:类上的映射是固定的,方法上的是不固定的。
  3. @GetMapping,@PostMapping,@PutMapping,@DeleteMapping
    • 注解作用:注解之意见注解名称
    • 定义范围:方法上
  4. @Data(lombox包)
    • 注解作用:为类提供读写属性, 此外还提供了 equals()、hashCode()、toString() 方法。pom文件需要导lombox包,idea需要下载lombox插件
    • 定义范围:类上
    • 同类型的:↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓注解作用如下↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
    • @Getter/@Setter : 注解在类上, 为类提供读写属性
    • @ToString : 注解在类上, 为类提供 toString() 方法
    • @Log4j : 注解在类上, 为类提供一个属性名为 log 的 log4j 的日志对象
    • @Slf4j : 注解在类上, 为类提供一个属性名为 log 的 log4j 的日志对象
  5. @API,@ApiModelProperty,@ApiOperation…(Swagger重要注解)
    • 注解作用:首先,Swagger是当前最好用的Restful API文档生成的开源框架,我们可以通过一点简单的注解声明,Swagger自动的生成api文档,并且可以通过Swagger-ui来模拟访问接口。
    • 定义范围:类上,方法上,属性上
    • ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓注解作用如下↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
    • @Api,作用在类上,对类的说明,如:这个类是干什么的,主要做哪方面的业务,这个类有什么用等等
    • @ApiOperation,作用在方法上,给就是接口,给接口增加说明,这个接口,是干嘛的。
    • @ApiImplicitParams,设置方法参数,就是接口参数说明,配合着@ApiImplicitParams,也就是说是这样用的@ApiImplicitParams({@ApiImplicitParam(),@ApiImplicitParam()})
    • @ApiModelProperty,作用在model上,可以对类的属性进行说明