SpringBoot 常用注解用法总结

1.@PathVariable 和 @RequestParam

        地址1：http://localhost:8989/SSSP/emps?pageNo=2

　　地址2：http://localhost:8989/SSSP/emp/7

　　如果想获取地址1中的 pageNo的值 ‘2’ ，则使用  @RequestParam ，

　　如果想获取地址2中的 emp/7 中的 ‘7 ’   则使用 @PathVariable

@RequestMapping(value="/getTaobao")
    public List<Taobao> doAddTaobao(@RequestParam(required = false) Integer status{
        return taobaoService.getTaobao(status);
    }
@RequestMapping(value = "/auditTaobao/{id}")
public void doAuditTaobao(@PathVariable Integer id){
      taobaoService.auditTaobao(id);
}

2.@valid

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>

@Valid注解用于校验，所属包为：javax.validation.Valid。

(1)、首先需要在实体类的相应字段上添加用于充当校验条件的注解，如：@NotEmpty如下代码（User类中的属性）：

@Entity
@Table(name="t_user")
public class User {
 
    @Id
    @GeneratedValue
    private Integer id; // 编号
 
    @NotEmpty(message="请输入用户名!")
    @Column(length=50)
    private String userName; // 用户名
 
    @NotEmpty(message="请输入密码!")
    @Column(length=50)
    private String password; // 密码
 
    @Column(length=50)
    private String trueName; // 真实姓名
 
    @Column(length=1000)
    private String remarks; // 备注
}

(2)、其次在controller层的方法的要校验的参数上添加@Valid注解，并且需要传入BindingResult对象，用于获取校验失败情况下的反馈信息，如下代码：

/**
     * 用户登录判断
     * @param user
     * @param bindingResult
     * @param session
     * @return
     */
    @ResponseBody
    @RequestMapping("/login")
    public Map<String,Object> login(@Valid User user, BindingResult bindingResult, HttpSession session){
        Map<String,Object> map=new HashMap<String,Object>();
        if(bindingResult.hasErrors()){
            map.put("success", false);
            map.put("errorInfo", bindingResult.getFieldError().getDefaultMessage());
            return map;
        }
        
 
    }

bindingResult.getFieldError.getDefaultMessage()用于获取相应字段上添加的message中的内容，如：@NotEmpty(message="请输入用户名!")注解中message属性的内容

更多的用法如下：

限制    说明
@Null    限制只能为null
@NotNull    限制必须不为null
@AssertFalse    限制必须为false
@AssertTrue    限制必须为true
@DecimalMax(value)    限制必须为一个不大于指定值的数字
@DecimalMin(value)    限制必须为一个不小于指定值的数字
@Digits(integer,fraction)    限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future    限制必须是一个将来的日期
@Max(value)    限制必须为一个不大于指定值的数字
@Min(value)    限制必须为一个不小于指定值的数字
@Past    限制必须是一个过去的日期
@Pattern(value)    限制必须符合指定的正则表达式
@Size(max,min)    限制字符长度必须在min到max之间
@Past    验证注解的元素值（日期类型）比当前时间早
@NotEmpty    验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@NotBlank    验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email    验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式
 

 

3.通用Mapper

就是为了解决单表增删改查，基于Mybatis的插件。开发人员不需要编写SQL，不需要在DAO中增加方法，只要写好实体类，就能支持相应的增删改查方法。

使用@Mapper注解

为了让DemoMapper能够让别的类进行引用，我们可以在DemMapper类上添加@Mapper注解：

这种方式要求每一个mapper类都需要添加此注解，麻烦。

使用@MapperScan注解

通过使用@MapperScan可以指定要扫描的Mapper类的包的路径

4.@Controller +@RequestMapping

@Controller初始化一个controller，用@RequestMapping给出它的访问路径，或者说触发路径，触发条件。

 

@ResponseBody 

将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据，需要注意的是，在使用此注解之后不会再走视图处理器，而是直接将数据写入到输出流（InputStream(字节输入流)，或者抽象类Reader(字符输入流)，抽象类OutputStream(字节输出流)或者Writer(字符输出流)）中，他的效果等同于通过response对象输出指定格式的数据

@RestController注解相当于@Controller + @ResponseBody 合在一起的作用。

 

5.@SpringBootApplication

扫描组件，在main方法上声明，入口

 

6.@PropertySource

@PropertySource是Spring boot为了方便引入properties配置文件提供的一个注解，可以标注在SpringBoot的启动类上，还可以标注在配置类（使用@Configuration标注的类）上。

 

7.@ConfigurationProperties和@EnableConfigurationProperties

@ConfigurationProperties注解主要用来把properties配置文件转化为bean来使用的，而@EnableConfigurationProperties注解的作用是@ConfigurationProperties注解生效。如果只配置@ConfigurationProperties注解，在IOC容器中是获取不到properties配置文件转化的bean的。