当前位置：首页>后端>正文

java常用注解及spring常见注解

后端2024-04-28 12:20:31

@PostMapping

对应接收参数的注解：@RequestBody
解释：一个类的时候，或者你不想你的参数直观的被用户看到，因为PostMapping,接收参数正常是放在Body里面的，而不是拼在请求地址后面的，所以相对来说要安全一点儿，所以涉及数据库的添加、修改信息等操作、适合用这个。
举例：手机号密码登录接口

@Data
@ApiModel("手机号密码认证参数")
public class LoginByPhonePassword {
    @ApiModelProperty(value = "手机号码", required = true)
    private String phone;

    @ApiModelProperty(value = "用户密码", required = true)
    private String password;
}

    @ApiOperation("手机号密码登录")
    @PostMapping("/loginByPhonePassword")
    public void loginByPhonePassword(@Valid @RequestBody LoginByPhonePassword loginByPhonePassword){
    //TO-DO U R thing
    }

@GetMapping

对应接收参数的注解：@RequestParam 、@PathVaiable
解释：参数是拼接在请求地址后面的，如果你觉得你要传输到后端接口的东西是无关紧要的而且数量很少，就一个两个，用GetMapping确实还是比较方便的。
举例：根据ID查询用户信息

    @ApiOperation("根据ID查询个人信息")
    @GetMapping("/getUserInfoById")
    public void loginByPhonePassword(@RequestParam("id") Integer id ){
    //TO-DO U R thing
    }

@ApiOperation swagger注解

1.@ApiOperation不是spring自带的注解是swagger里的
2.注解@ApiOperation 和@ApiParam是用来构建Api 文档的
3.@ApiOperation(value="接口说明"，httpMethod="接口请求方式"，response="接口返回参数类型"，notes="接口发布说明")；其他参数可参考源码
4.@ApiParam(required ="是否必须参数"，name="参数名称",value="参数具体描述")

@ApiOperation(value = "分页获取农村保洁-积分审核列表")
@ApiImplicitParams({
@ApiImplicitParam(name = "size", value = "页面大小，默认10", dataType = "int", paramType = "query"),
@ApiImplicitParam(name = "current", value = "当前页码，默认1", dataType = "int", paramType = "query"),
@ApiImplicitParam(name = "kw", value = "关键字", dataType = "String", paramType = "body"),
@ApiImplicitParam(name = "status", value = "审核状态 0-未审核 1-已审核 2-已驳回 4-审核中", dataType = "String", paramType = "body"),
@ApiImplicitParam(name = "type", value = "积分类型当前卫生", dataType = "String", paramType = "body"),
@ApiImplicitParam(name = "zid", value = "镇id", dataType = "int", paramType = "query"),
@ApiImplicitParam(name = "cid", value = "村庄id", dataType = "int", paramType = "query"),
// @ApiImplicitParam(name = "audit_status", value = "审核状态 0-未审核 1-已审核 2-已驳回 4-审核中", dataType = "int", paramType = "query"),
})

 
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.2.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.2.2</version>
</dependency>

@Transactional spring中管理事务一般使用
@Resource和@Autowired 都是为了装配Bean，但是两者在使用上又有少许区别

1.@Autowired是默认按照类型装配Bean，当需要用名称装配时，可以在@Autowired后面使用@Qualifier注解指定name属性，来告知容器加载哪个bean
2.@Resource默认按照名字装配Bean，即会按照name属性的值来找到具有相同id的Bean Definition 并注入。如果@Resource没有指定name属性，则会根据这个将要被注入的属性的名字来进行Bean装配。这段话有点绕口，下面结合例子来展示。

@Autowired() @Qualifier("baseDao")     
private BaseDao baseDao;

@Resource(name="baseDao")     
private BaseDao baseDao;

@Data注解

@Data : 注解在类上, 为类提供读写属性, 此外还提供了 get()、 set()、 toString()equals()、hashCode()、toString() 等方法。

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.4</version>
    <scope>provided</scope>
</dependency>

其他相关注解:

@Data ：注在类上，提供类的get、set、equals、hashCode、toString等方法
@AllArgsConstructor ：注在类上，提供类的全参构造
@NoArgsConstructor ：注在类上，提供类的无参构造
@Setter ：注在属性上，提供 set 方法
@Getter ：注在属性上，提供 get 方法
@EqualsAndHashCode ：注在类上，提供对应的 equals 和 hashCode 方法
@Log4j/@Slf4j ：注在类上，提供对应的 Logger 对象，变量名为 log

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@TableName("clean_integral_audio")
@ApiModel(value="CleanIntegralAudio对象", description="农村保洁-积分审核")
public class CleanIntegralAudio implements Serializable {

    private static final long serialVersionUID = 1L;

    @TableId(value = "id", type = IdType.AUTO)
    private Long id;