spring中的一些注解

@NotBlank、@NotEmpty和@NotNull

@NotBlank

只能用在String字符串类型上，而且调用trim()后，长度必须大于0(size>0)

@NotEmpty

主要用在集合类上面，加了@NotEmpty的String类、Collection、Map、数组，是不能为null而且长度必须大于0

@NotNull

不能为null，但可以为empty

// @NotNull: false
// @NotEmpty: false
// @NotBlank: false
String name = null;

// @NotNull: true
// @NotEmpty: false
// @NotBlank: false
String name = "";

// @NotNull: true
// @NotEmpty: true
// @NotBlank: false
String name = " ";

三个注解都放在属性上，用来对属性值进行一定的限制

@NotBlank(message = "msg不能为空")
private String msg;

@Link

写代码的时候，有时候，你需要写一些注释，把内容相互关联起来，方便自己或别人看的时候，可以直接找到你关联的代码类。这时@Link就排上用场了，点击对应类可以看到对应类的javaDoc注释

/**
 * <p>自定义过滤器</p><br>
 *
 * 将原生{@link HttpServletRequestWrapper}对象替换成自定义的{@link RequestWrapper}对象
 *
 * @author  xxx
 * @date  2022年10月20日16:27:34
 **/

其效果如下图

@Value

在使用Spring框架的项目中，@Value是使用比较频繁的注解之一，它的作用是将配置文件中key对应的值赋值给它标注的属性。

支持形式

@Value属性注入功能根据注入的内容来源可分为两类：通过配置文件的属性注入和通过非配置文件的属性注入。

基于配置文件注入

Spring boot 项目中，可以使用@Value(${})取出默认路径下的配置文件中的值来给属性赋值

基于非配置文件注入

SpEL（Spring Expression Language）即Spring表达式语言，可以在运行时查询和操作数据。使用#{...}作为定界符, 所有在大括号中的字符都将被认为是 SpEL。

/**
 * 注入普通字符串，相当于直接给属性默认值
 */
@Value("程序新视界")
private String wechatSubscription;

/**
 *  注入操作系统属性
 */
@Value("#{systemProperties['os.name']}")
private String systemPropertiesName;

/**
 * 注入表达式结果
 */
@Value("#{ T(java.lang.Math).random() * 100.0 }")
private double randomNumber;

/**
 * 注入其他Bean属性：注入config对象的属性tool
 */
@Value("#{config.tool}")
private String tool;

/**
 * 注入列表形式（自动根据"|"分割）
 */
@Value("#{'${words}'.split('\\|')}")
private List<String> numList;

/**
 * 注入文件资源
 */
@Value("classpath:config.xml")
private Resource resourceFile;

/**
 * 注入URL资源
 */
@Value("http://www.choupangxia.com")
private URL homePage;

默认值注入

无论使用#{}或${}进行属性的注入，当无法获取对应值时需要设置默认值，可以采用如下方式来进行设置。

/**/**
 * 如果属性中未配置ip，则使用默认值
 */
@Value("${ip:127.0.0.1}")
private String ip;

/**
 * 如果系统属性中未获取到port的值，则使用8888。
 */
@Value("#{systemProperties['port']?:'8888'}")
private String port;

其中${}中直接使用:对未定义或为空的值进行默认值设置，而#{}则需要使用?:对未设置的属性进行默认值设置。

@PostConstruct

如果我们需要在程序启动时就加载某些数据。比如，在程序启动的过程中需要从数据库中加载数据并缓存到程序的内存中

对此，我们可以在容器启动的过程中，通过依赖查找的方法获取到mappe，然后从数据库中获取数据并缓存到内存中，如下

public class MainClass {

    public static ClassPathXmlApplicationContext context = null;

    private static CountDownLatch shutdownLatch = new CountDownLatch(1);

    public static void main(String[] args) throws Exception {
        // 加载spring上下文
        context = new ClassPathXmlApplicationContext(new String[]{"spring-config.xml"});
        context.start();
        // 从数据库获取数据并缓存到内存
        // 1.从容器中获取mapper
        ConfigMapper configMapper = (ConfigMapper) context.getBean("configMapper");
        // 2.从数据库中获取数据
        List<Config> RuleResultSet = configMapper.selectAll();
        // 3.将数据加载到PropertyMap中
        RuleResultSet.forEach(config -> PropertyMap.add(config.getName(), config.getValue()));
        context.registerShutdownHook();
        shutdownLatch.await();
    }
}

除此以外，我们还可以通过更加简洁的方式来实现，这就需要用到@PostConstruct注解

@Component
public class InitConfigParameter {

    @Resource
    private ConfigMapper configMapper;
 
    @PostConstruct
    public void init() throws Exception {
        // 将数据库中的参数加载到哈希表中
        List<ItpcsConfig> RuleResultSet = configMapper.selectAll();
        RuleResultSet.forEach(config -> PropertyMap.add(config.getName(), config.getValue()));
    }
}

使用@PostConstruct注解修饰的init方法就会在Spring容器的启动时自动的执行，其具体实现原理可以参考https://juejin.cn/post/7010017313625735198

@Retention、@Target

注解@Target和@Retention可以用来修饰注解，是注解的注解，称为元注解

@Retention

@Retention作用是定义被它所注解的注解保留多久，一共有三种策略，定义在RetentionPolicy枚举中.

• RetentionPolicy.SOURCE：注解只保留在源文件，当Java文件编译成class文件的时候，注解被遗弃；被编译器忽略
• RetentionPolicy.CLASS：注解被保留到class文件，但jvm加载class文件时候被遗弃，这是默认的生命周期
• RetentionPolicy.RUNTIME：注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在

这3个生命周期分别对应于：Java源文件(.java文件) —-> .class文件 —-> 内存中的字节码。

首先要明确生命周期长度 SOURCE < CLASS < RUNTIME ，所以前者能作用的地方后者一定也能作用。一般如果需要在运行时去动态获取注解信息，那只能用 RUNTIME 注解；如果要在编译时进行一些预处理操作，比如生成一些辅助代码（如 ButterKnife），就用 CLASS注解；如果只是做一些检查性的操作，比如 @Override 和 @SuppressWarnings，则可选用 SOURCE 注解。

@Target

目标，即该注解可以声明在哪些目标元素之前，也可理解为注释类型的程序元素的种类。

• ElementType.PACKAGE：用于描述包。
• ElementType.ANNOTATION_TYPE：该注解只能声明在一个注解类型前。
• ElementType.TYPE：用于描述类、接口(包括注解类型) 或enum声明
• ElementType.CONSTRUCTOR：用于描述类的构造器。
• ElementType.LOCAL_VARIABLE：用于描述局部变量。
• ElementType.METHOD：用于描述类的方法。
• ElementType.PARAMETER：用于描述方法参数。
• ElementType.FIELD：用于描述域(一个类的字段前).

定义注解

定义注解需使用 @interface关键词 ,并在接口上注明@Rentention(…) 或@Target(…) ，也可以把spring等注解加上来使用

@Target({ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation{
    //定义final静态属性
    //定义抽象方法
}

比如：

@Target({ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Transactional(value = "transactionManager", propagation = Propagation.REQUIRED, rollbackFor = Exception.class)
public @interface TestAnnotation{
 
}

注解的使用：

@TestAnnotation
public String save(Person person){
}

@RequestParam

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestParam {
 
    /**
     * 参数名称（和value同等意思）
     */
    @AliasFor("name")
    String value() default "";
 
    /**
     * 参数名称 (和name同等意思)
     */
    @AliasFor("value")
    String name() default "";
 
    /**
     * 是否必选（默认必选）
     */
    boolean required() default true;
 
    /**
     * 参数默认值
     */
    String defaultValue() default ValueConstants.DEFAULT_NONE;
 
}

参数：

@RequestParam总体上来说，该注解类拥有三个:

• value、name 属性都标识请求参数名（必须配置）;
• required：参数是否必传，默认为 true，可以设置为非必传 false；（如果设置了必传或默认，请求未传递参数，将会抛出异常）;
• defaultValue：参数默认值，如果设置了该值，required 将会自动设置为 false；

获取到的参数放在请求哪

• get请求的 requestHeaders 中content-type这个字段，使用form-data 表单形式携带参数请求；
• Spring中的@RequestParam注解接收的参数大多数场景是来自requestHeaders中，即请求头，也就是url中，格式为：http://localhost:8080/?name=yc&age=23，由于 url 长度有限制，所以参数需要限制数量和值的长度；

请求示例

使用@RequestParam注解获取参数

@RequestMapping(value = "/test", method = RequestMethod.GET)
public void test(@RequestParam("id") Integer id,
                 @RequestParam("name") String name,
                 @RequestParam("age") Integer age) {
    log.info("id = {}, name = {}, age = {}", id, name, age);  // id = 1, name = yc, age = 23
}

不使用@RequestParam注解直接进行对象属性赋值（不推荐使用，容易和@ReuqestBody混淆）

@RequestMapping(value = "/test", method = RequestMethod.GET)
public void test(User user) {
    //  id = 1, name = yc, age = 23
    log.info("id = {}, name = {}, age = {}", user.getId(), user.getName(), user.getAge());
}

使用场景

• 请求是为了查找资源，获取服务器数据；
• 请求结果无持续性的副作用，例如：不会对数据库进行添加、修改、删除操作；
• 传入的参数不会太长，因为Get请求可能会产生很长的URL，或许会超过某些浏览器与服务器对URL的长度限制，导致请求失败；

@RequestBody

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestBody {
 
    /**
     * 默认参数必传
     */
    boolean required() default true;
 
}

参数

@RequestBody注解只拥有一个参数:required 默认为 true，即对象中的属性必须有一个要传，否则会抛出异常

获取到的参数放在请求哪

• post请求的requestHeaders请求头中有content-type字段，一般用来处理：applicatin/json格式的参数；
• Spring中的@RequestBody注解是用来接收请求体中的参数数据，即requestBody请求体中，故不受参数数据长度的限制；

请求示例

@RequestMapping(value = "/test", method = RequestMethod.POST)
public void test(@RequestBody User user) {
    // id = 1, name = yc, age = 23
    log.info("id = {}, name = {}, age = {}", user.getId(), user.getName(), user.getAge()); 
}

使用场景

• 请求的结果有持续性作用，例如：对数据库添加、更新、删除操作；
• 若使用Get请求，表单参数过长；
• 要传送的数据不是采用7位的ASCII编码；

测试

使用Post请求，@RequestParam也可以接收参数；

注意：也可以使用这种方式用，发送Post请求，参数拼接到url之后，这是因为协议之间没有做严格的区分，但这种方式不建议使用，这种方式就使用Get方式即可。例如：localhost:8888/optimus-prime/project/test?id=1&name=yc&age=23 使用浏览器请求数据，这种方式Get请求，但后端使用Post方式接收，访问不成功！

@PostMapping(value = "/test")
public void test(@RequestParam("id") Integer id,
                 @RequestParam("name") String name,
                 @RequestParam("age") Integer age) {
    log.info("id = {}, name = {}, age = {}", id, name, age); // id = 1, name = yc, age = 12
}