每日一个注解

雨点打透心脏的1/2处 2024-03-30 15:57 26阅读 0赞

## 1. bean注入注解 ##

### 1.1. @Component ###

把普通的类实例化到spring容器中，相当于配置文件中的 `<bean id="" class=""/>`。泛指各种组件，就是说当我们的类不属于各种归类的时候（不属于@Controller、@Repository、@Services等的时候），我们就可以使用@Component来标注这个类。

无论是@Controller、@Service还是@Repository全部都被@Component注解了，注解会一级一级向上递归搜索。

### 1.2. @Controller ###

用于标注控制层服务。

### 1.3. @Service ###

用于标注业务逻辑层服务，主要用来进行业务的逻辑处理，注入DAO。这种bean默认是单例的，如果想改变，可以使用@Service(“beanName”) 、@Scope(“prototype”)来改变。

### 1.4. @Repository ###

用于标注数据访问层，也可以说用于标注数据访问组件，即DAO组件。

@Repository需要用@MapperScan扫描mapper才能注入@Bean,而@Mapper注解相当于@Repository注解+@MapperScan注解,通过[xml][]文件下的namespace命名空间自动注入bean

该注解的作用不只是将类识别为Bean，同时它还能将所标注的类中抛出的数据访问异常封装为 Spring 的数据访问异常类型。 Spring本身提供了一个丰富的并且是与具体的数据访问技术无关的数据访问异常结构，用于封装不同的持久层框架抛出的异常，使得异常独立于底层的框架。

### 1.5. @bean 和 @component 的区别 ###

1.  作用对象不同：`@Component` 注解作用于类，而 `@Bean` 注解作用于方法，主要用在`@Configuration`注解的类里，也可以用在`@Component`注解的类里（会出现问题，不是单例）。
2.  `@Component` 通常是通过路径扫描来自动侦测以及自动装配到 Spring 容器中(我们可以使用 `@ComponentScan` 自动装配到 Spring 的 bean 容器中)。`@Bean` 注解通常是我们在标有该注解的方法中定义产生这个 bean，`@Bean` 告诉了 Spring 这是某个类的实例，当我们需要用它的时候给我。
3.  `@Bean` 注解比 `@Component` 注解的自定义性更强，比如当我们引用第三方库中的类需要装配到 Spring 容器时，只能通过 `@Bean` 来实现。

## 2. @Mapper与 @Repository区别 ##

### 2.1. @Mapper ###

是 Mybatis 的注解，和 Spring 没有关系，@Repository 是 Spring 的注解，用于声明一个 Bean。

仅仅使用@Mapper注解，我们会发现，在其他变量中依赖注入，IDEA 会提示错误，但是不影响运行（亲测～）。

尽管这个错误提示并不影响运行，但是看起来很不舒服，所以我们可以在对应的接口上添加 bean 的声明，如下：

@Repository // 也可以使用@Component，效果都是一样的，只是为了声明为bean
    @Mapper
    public interface UserDao {
        
    	@Insert("insert into user(account, password, user_name) " +
                "values(#{user.account}, #{user.password}, #{user.name})")
        int insertUser(@Param("user") User user) throws RuntimeException;
    }

### 2.2. @Repository ###

正如上面说的，@Repository 用于声明 dao 层的 bean，如果我们要真正地使用 @Repository 来进行开发，那是基于代码的开发，简单来说就是手写 JDBC。

@Repository
    public class UserDaoImpl implements UserDao{
        
    	
    	@Override
    	public int insertUser(){
        
    		JdbcTemplate template = new JdbcTemplate();
    		...
    	}
    }

### 2.3. 总结 ###

1.  @Mapper 一定要有，否则 Mybatis 找不到 mapper。
2.  @Repository 可有可无，可以消去依赖注入的报错信息。
3.  @MapperScan 可以替代 @Mapper。

## 3. 为什么 Spring 不推荐使用 @Autowired 注解+常见的注入方式 ##

*  构造器注入：利用构造方法的参数注入依赖
 *  Setter注入：调用Setter的方法注入依赖
 *  字段注入：在字段上使用@Autowired/Resource注解

### 3.1. @Autowired 注解缺点 ###

#### 3.1.1. 对象外部不可见 ####

@RestController
    public class TestHandleController {
        
    
        @Autowired
        TestHandleService testHandleService;
    
        public void helloTestService(){
        
            testHandleService.hello();
        }
    }

字段注入的非常的简便，通过以上代码我们就可以轻松的使用TestHandleService类，但是如果变成下面这样呢：

TestHandleController testHandle = new TestHandleController();
    testHandle.helloTestService();

这样执行结果为空指针异常，这就是字段注入的第一个问题：\*\*对象的外部可见性，\*\*无法在容器外部实例化TestHandleService（例如在测试类中无法注入该组件），类和容器的耦合度过高，无法脱离容器访问目标对象。

#### 3.1.2. 循环依赖（其他方式注入也有） ####

public class TestA(){
        
    
        @Autowired
        private TestB testB;
    
    }
    
    public class TestB(){
        
    
        @Autowired
        private TestA testA;
    
    }

#### 3.1.3. **无法设置注入的对象为final，也无法注入静态变量** ####

详细可看：[https://www.cnblogs.com/lvdeyinBlog/p/15178226.html][https_www.cnblogs.com_lvdeyinBlog_p_15178226.html]

### 3.2. @Autowired VS @Resource ###

*  依赖识别方式：@Autowired默认是byType可以使用@Qualifier指定Name，@Resource默认ByName如果找不到则ByType
 *  适用对象：@Autowired可以对构造器、方法、参数、字段使用，@Resource只能对方法、字段使用
 *  提供方：@Autowired是Spring提供的，@Resource是JSR-250提供的

### 3.3. 各种注入方式的优缺点 ###

*  构造器注入：强依赖性（即必须使用此依赖），不变性（各依赖不会经常变动）
 *  Setter注入：可选（没有此依赖也可以工作），可变（依赖会经常变动）
 *  Field注入：大多数情况下尽量少使用字段注入，一定要使用的话， @Resource相对@Autowired对IoC容器的耦合更低

## 4. SpringBoot配置中@ConfigurationProperties和@Value的区别 ##

### 4.1. 两者比较 ###

**@ConfigurationProperties**：可以将配置文件中的属性值批量注入到类的各个属性；  
**@Value**：为类中的各个属性逐个赋值

<table> 
 <thead> 
  <tr> 
   <th></th> 
   <th><strong>@ConfigurationProperties</strong></th> 
   <th><strong>@Value</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>功能</td> 
   <td>批量注入配置文件中的属性</td> 
   <td>一个个指定</td> 
  </tr> 
  <tr> 
   <td>松散绑定</td> 
   <td>支持</td> 
   <td>不支持</td> 
  </tr> 
  <tr> 
   <td>SpEL</td> 
   <td>不支持</td> 
   <td>支持</td> 
  </tr> 
  <tr> 
   <td>JSR303数据校验</td> 
   <td>支持</td> 
   <td>不支持</td> 
  </tr> 
  <tr> 
   <td>复杂类型封装</td> 
   <td>支持</td> 
   <td>不支持</td> 
  </tr> 
 </tbody> 
</table>

**说明**：松散绑定包括驼峰写法、短横写法（-）、下划线写法（\_），例如druid-spring-boot-starter官方配置默认就使用短横写法

空检查 
    @Null 验证对象是否为null 
    @NotNull 验证对象是否不为null, 无法查检长度为0的字符串 
    @NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格. 
    @NotEmpty 检查约束元素是否为NULL或者是EMPTY.
    
    Booelan检查 
    @AssertTrue 验证 Boolean 对象是否为 true 
    @AssertFalse 验证 Boolean 对象是否为 false
    
    长度检查 
    @Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内 
    @Length(min=, max=) 字符串长度检查Validates that the annotated string is between min and max included.
    
    日期检查 
    @Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期 
    @Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期 
    @Pattern 验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。
    
    数值检查 
    建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为”“,Integer为null 
    @Min 验证 Number 和 String 对象是否大等于指定的值 
    @Max 验证 Number 和 String 对象是否小等于指定的值 
    @DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度 
    @DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度 
    @Digits 验证 Number 和 String 的构成是否合法 
    @Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。 
    @Range(min=, max=) 被指定的元素必须在合适的范围内 
    @Range(min=10000,max=50000,message=”range.bean.wage”) 
    @Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证) 
    @CreditCardNumber信用卡验证 
    @Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。 
    @ScriptAssert(lang= ,script=, alias=) 
    @URL(protocol=,host=, port=,regexp=, flags=)

### 4.2. @ConfigurationProperties常用两种使用方式 ###

第一种：一般在配置环境的时候使用

配置文件：

config.id=123
    config.name=张三
    config.email=123

对应类：

@ConfigurationProperties(prefix = "config")
    public class testConfig {
        
    	String name;
    	int id;
    	String email;
    }

配置类:在这里有个@EnableConfigurationProperties注解，意思是让@ConfigurationProperties这个注解生效

@Configuration
    @EnableConfigurationProperties(testConfig.class)
    public class Config {
        
    	@Bean
    	public testConfig co(testConfig testConfig) {
        
    		return testConfig;
    	}
    }

第二种：一般通过注入来使用

配置：

student:
      age: 25
      class: mba
      lists: a,b,c
      mail: zhangsan@gmail.com
      maps:
        k1: aaa
        k2: bbb
        k3: ccc
      name: zhangsan
      score:
        english: 95
        math: 90
      squad-leader: false

对应类：只需要加一个能够被spring扫描到的注解就可以

@Component
    // @PropertySource表示将外部配置文件加载到spring容器中管理
    // @PropertySource(value = {"classpath:student.properties"})
    @ConfigurationProperties(prefix = "student")
    // prefiex表示指定统一前缀，下面就不用再写了
    @Validated // ConfigurationProperties形式下支持JSR303校验
    public class StudentCP {
        
    
        private String name;
    
        private Integer age;
    
        // 支持松散绑定，可以将连接符转成驼峰命名
        private Boolean squadLeader;
    
        // 当前形式下支持JSR303数据校验，表示此属性值必须是email的格式
        @Email
        private String mail;
    
        // 支持复杂类型封装对应
        private Map<String, Object> maps;
    
        private List<Object> lists;
    
        private Score score;
    
    }

### 4.3. @Value使用 ###

**注意**：StudentV 的实例对象必须为spring bean，可通过@bean、@Component（包括@Controller、@Service、@Configuration等）

@Component
    public class StudentV {
        
    
        // 使用@Value的话只能给属性一一指定映射
    
        @Value("student.name")
        private String name;
    
        // @Value形式支持SpEL表达式
        @Value("#{13*2}")
        // @Value("student.age")
        private Integer age;
    
        // @Value("true") // 可直接赋值
        // 不能支持松散语法的绑定
        @Value("student.squad-leader")
        private Boolean squadLeader;
    
        @Value("student.mail")
        private String mail;
    
        // 之后的map、list和对象等复杂形式对象@Value无法支持
    
    }

[xml]: https://so.csdn.net/so/search?q=xml&spm=1001.2101.3001.7020
[https_www.cnblogs.com_lvdeyinBlog_p_15178226.html]: https://www.cnblogs.com/lvdeyinBlog/p/15178226.html