标签: java spring boot 插件

注解介绍

  1. @NonNull
    这个注解可以用在成员方法或者构造方法的参数前面,会自动产生一个关于此参数的非空检查,如果参数为空,则抛出一个空指针异常。
  2. @Data :注解在类上;提供类所有属性的 getting 和 setting 方法,此外还提供了equals、canEqual、hashCode、toString 方法
  3. @NoArgsConstructor:注解在类上;为类提供一个无参的构造方法
  4. @AllArgsConstructor:注解在类上;为类提供一个全参的构造方法
  5. @Cleanup:关闭流
  6. @Synchronized:对象同步
  7. @SneakyThrows:抛出异常
  8. @Builder : 使用builder模式创建对象

代码规范

Restful api

注解

  1. @GetMapping : 查询
  2. @PostMapping : 插入
  3. @PutMapping : 更新
  4. @PatchMapping : 更新部分资源
  5. DeleteMapping : 删除

swagger注解

与接口相关的注解

  1. @Api:写在接口类上标明此controller类是什么接口,@Api(value=”xxxx”)
  2. @ApiOperation:标注在接口方法上,标明接口方法是干啥的,@ApiOperation(value=”xxxxxxxx”)
  3. @ApiImplicitParams:标注在接口方法上,标明接口方法的一组参数信息
    @ApiImplicatParam:表示接口方法的单个参数具体信息

    • value:接口参数含义
    • name:接口参数命名
    • required:参数是否必须传
    • dataType:接口参数的类型
    • paramType:参数所放置的地方,包含query、header、path、body以及form,最常用的是前四个

      • query:请求参数的获取:@RequestParam
      • header:放在header中 请求参数的获取:@RequestHeader
      • path:放在url中 请求参数的获取:@PathVariable
      • body:放在body中 请求参数的获取:@RequestBody
      • form:
      • 注意:query、form域中的值需要使用@RequestParam获取, header域中的值需要使用@RequestHeader来获取,path域中的值需要使用@PathVariable来获取,body域中的值使用@RequestBody来获取

作者 @zzxhub
2018 年 07月 07日