SpringBoot - @Bean注解详解

Posted 2023-03-29 cloneme01

写在前面

Spring在启动时能够把BEAN(JAVA组件)注册到ioc容器里，实现控制反转，开发人员在使用Spring开发应用时，是看不到new关键字的，所有对象都应该从容器里获得，它们的生命周期在放入容器时已经确定。@Bean注解就是把我们将要实例化的对象转化成一个Bean，放在Spring容器中，等我们使用时，就会和@Autowired、@Resource配合到使用拿到该实例。注册BEAN的方法有@ComponentScan、@Bean、@Import、@Component、@Repository、@ Controller、@Service 、 @Configration等等。
SpringBoot - 向容器中注册组件的方法有哪些？
SpringBoot - @Configuration注解使用详解

SpringBoot 推荐使用JAVA配置的方式来完全代替XML配置，JAVA配置是通过 @Configration 和 @Bean 注解实现的。
（1）@Configration 注解：用于声明当前类是一个配置类，相当于Spring中的一个 XML 文件；相当XML文件中的标签
（2）@Bean 注解：作用在方法上，声明当前方法的返回值是一个Bean对象；相当XML文件中的标签。

注解作用

@Configuration与@Bean都是来自Spring的注解，作用是使用类来代替XML配置文件的功能，将一个POJO对象注入到Spring容器中。

基本概念

Spring的@Bean注解标注在方法上，用于告诉方法去产生一个Bean对象，然后把这个Bean对象交给Spring容器来管理，产生这个Bean对象的方法Spring只会调用一次。可以使用@Autowired或者@Resource注解获取Bean。(通过byTYPE方式（@Autowired）、byNAME方式（@Resource）)

使用说明

注解@Bean被声明在方法上，该方法都需要有一个返回类型，这个方法的返回类型就是注册到IOC容器中的类型，接口和类都是可以作为返回类型，介于面向接口原则，提倡返回类型为接口。该注解主要用在@Configuration注解的类的方法上，也可以用在@Component注解的类的方法上，添加的bean的id为方法名。

使用要点

（1）@Bean 注解：作用在方法上，方法都需要有一个返回类型；
（2）@Bean 注解：用于表示当前方法返回一个 Spring 容器管理的 Bean；
（3）@Bean 的默认的名字和方法名一致(一般Bean都是首字母小写，因为方法名的首字母一般都是小写的)；
（4）@Bean 注解：一般和 @Component 或者 @Configuration 一起使用；
（5）@Bean 注解：默认作用域为单例作用域，可通过 @Scope(“prototype”) 设置为原型作用域；
（6）@Bean 注解：可以接受一个 String 数组来设置多个别名；
（7）@Configration 注解类中可以声明多个 @Bean 的方法，并且声明的 Bean 与 Bean 之间是可以有依赖关系的；

组合使用

@Bean 注解常常与 @Scope、@Lazy，@DependsOn 和 @link Primary 注解一起使用：
（1）@Profile 注解：为不同环境下不同的配置提供了支持，如开发和生产环境的数配置是不同的；
（2）@Scope 注解：将 Bean 的作用域从单例改变为指定的作用域；
（3）@Lazy 注解：只有在默认单例作用域的情况下才有实际效果；
（4）@DependsOn 注解：表示在当前 Bean 创建之前需要先创建特定的其他 Bean的场景时，添加该注解。

示例代码

//
public class MyHello 
    public void init() 
        System.out.println("初始化...");
    
    public void destroy() 
        System.out.println("销毁...");
    
    public String get() 
        return "获取信息...";
    

//
@Configuration
public class MyConfiguration 
	// init和destroy都是这个Bean的方法。
    @Bean(initMethod = "init", destroyMethod = "destroy")
    public MyHello hi() 
        return new MyHello();
    

//
@RestController
public class HelloController 
	@Autowired
	private MyHello hello;
 
    @GetMapping("/test")
    public String test() 
    	logger.info(hello.get());
        return "OK";
    

源码、示例及DEMO

源码、示例及DEMO

SpringBoot Validation参数校验 详解自定义注解规则和分组校验

参考技术A Hibernate Validator 是 Bean Validation 的参考实现 。Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint
在日常开发中，Hibernate Validator经常用来验证bean的字段，基于注解，方便快捷高效。

在SpringBoot中可以使用@Validated，注解Hibernate Validator加强版，也可以使用@Valid原来Bean Validation java版本

Bean Validation 中内置的 constraint

<colgroup style="box-sizing: border-box;"><col style="box-sizing: border-box;"><col style="box-sizing: border-box;"></colgroup>

Hibernate Validator 附加的 constraint

message支持表达式和EL表达式 ，比如message = "姓名长度限制为min到max $1+2")

想把错误描述统一写到properties的话，在classpath下面新建
ValidationMessages_zh_CN.properties文件(注意value需要转换为unicode编码)，然后用格式的占位符

hibernate补充的注解中，最后3个不常用，可忽略。
主要区分下@NotNull @NotEmpty @NotBlank 3个注解的区别：

如果同一个参数，需要在不同场景下应用不同的校验规则，就需要用到分组校验了。比如：新注册用户还没起名字，我们允许name字段为空，但是在更新时候不允许将名字更新为空字符。

分组校验有三个步骤：

自定义的Update分组接口继承了Default接口。校验注解(如： @NotBlank)和@validated默认其他注解都属于Default.class分组，这一点在
javax.validation.groups.Default注释中有说明

在编写Update分组接口时，如果继承了Default，下面两个写法就是等效的：
@Validated(Update.class),@Validated(Update.class,Default.class)
如果Update不继承Default，@Validated(Update.class)就只会校验属于Update.class分组的参数字段

如果 UserVO 类中增加一个 OrderVO 类的属性，而 OrderVO 中的属性也需要校验，就用到递归校验了，只要在相应属性上增加@Valid注解即可实现（对于集合同样适用）

validation 为我们提供了这么多特性，几乎可以满足日常开发中绝大多数参数校验场景了。但是，一个好的框架一定是方便扩展的。有了扩展能力，就能应对更多复杂的业务场景，毕竟在开发过程中，唯一不变的就是变化本身。 Validation允许用户自定义校验

实现很简单，分两步：

注意:message用于显示错误信息这个字段是必须的，groups和payload也是必须的
@Constraint(validatedBy =
HandsomeBoyValidator.class)用来指定处理这个注解逻辑的类

注意这里验证逻辑我抽出来单独写了一个工具类，ValidatorUtil

我自定义了补充了很多验证器，包括日期验证，枚举验证，手机号验证，金额验证

自定义校验注解使用起来和内置注解无异，在需要的字段上添加相应注解即可

使用 Validation API 进行参数效验步骤整个过程如下图所示，用户访问接口，然后进行参数效验 ，如果效验通过，则进入业务逻辑，否则抛出异常，交由全局异常处理器进行处理

全局异常出来请参考我这篇文章SpringBoot优雅的全局异常处理