spring注解及说明

日期： 2021-03-03
作者：库先生

经常会有Spring初学者搜索Spring注解及相关说明性文字，本篇文章主要以网络上搜集到的内容为主，结合自己的理解整理而成。

1. @Controller

@Controller：标注一个控制器组件类。标识一个该类是Spring MVC controller处理器，用来创建处理http请求的对象。组合注解（组合了@Component注解），应用在MVC层（控制层）

@Controller
public class TestController {
        @RequestMapping("/test")
        public String test(String name){
            return "hello";
        }
}

2. @RestController

Spring4之后加入的注解，原来在@Controller中返回json需要@ResponseBody来配合，如果直接用@RestController替代@Controller就不需要再配置@ResponseBody，默认返回json格式。

@RestController
public class TestController {
        @RequestMapping("/test")
        public String test(String name){
            return "hello";
        }
}

3. @Service

@Service 把类当做容器中的一个组件来使用。
当使用@Autowired注解则是实例化构造器。因为在自动注入时，是一个接口类型，所以要在容器中找到相应的实现类注入。故@Service加到类上。组合注解（组合了@Component注解），应用在service层（业务逻辑）。

@Service
public interface UserService {
   User login(String username,String password); 
}
//当把注解写在接口上时，spring容器会注入失败。


//注解写在类上  注入不会失败。
@Service
public class UserServiceImpl  implements UserService{
       @Autowired
       private  UserMapper userMapper;
}

@Controller
@RequestMapping("user")
public class UserController {

    @Autowired
    private UserService userService
}

4. @Reponsitory

@Repository注解便属于最先引入的一批，它用于将数据访问层 (DAO 层 ) 的类标识为 Spring Bean。具体只需将该注解标注在 DAO类上即可。为什么 @Repository 只能标注在 DAO 类上呢？这是因为该注解的作用不只是将类识别为Bean，同时它还能将所标注的类中抛出的数据访问异常封装为 Spring 的数据访问异常类型。 Spring本身提供了一个丰富的并且是与具体的数据访问技术无关的数据访问异常结构，用于封装不同的持久层框架抛出的异常，使得异常独立于底层的框架。组合注解（组合了@Component注解），应用在DAO层（数据访问层）。

5. @Component

把普通pojo实例化到spring容器中，相当于配置文件中的，表示一个带注释的类的一个"组件"，成为Spring管理的Bean。当使用基于注解的配置和类路径扫描时，这些类被视为自动检测的候选对象。同时@Component还是一个元注解。

6. @Configuration

@Configuration作用在类上，声明一个class需要被spring解析以扩充beanDefinition。
@Configration注解同时被@Component注解修饰，因此具有被自动加载的特点，被@Configuration修饰的类本身也会作为definition注册。value属性是Configuration bean名称。

7. @Resource

这个注解属于J2EE的。@Resource的作用相当于@Autowired，只不过@Autowired按byType自动注入，而@Resource默认按 byName自动注入罢了。@Resource有两个属性是比较重要的，分是name和type，Spring将@Resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。所以如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不指定name也不指定type属性，这时将通过反射机制使用byName自动注入策略。

@Resource装配顺序

如果同时指定了name和type，则从Spring上下文中找到唯一匹配的bean进行装配，找不到则抛出异常
如果指定了name，则从上下文中查找名称（id）匹配的bean进行装配，找不到则抛出异常
如果指定了type，则从上下文中找到类型匹配的唯一bean进行装配，找不到或者找到多个，都会抛出异常
如果既没有指定name，又没有指定type，则自动按照byName方式进行装配；如果没有匹配，则回退为一个原始类型进行匹配，如果匹配则自动装配；

8. @Bean

Spring的@Bean注解用于告诉方法，产生一个Bean对象，然后这个Bean对象交给Spring管理。产生这个Bean对象的方法Spring只会调用一次，随后这个Spring将会将这个Bean对象放在自己的IOC容器中。
SpringIOC 容器管理一个或者多个bean，这些bean都需要在@Configuration注解下进行创建，在一个方法上使用@Bean注解就表明这个方法需要交给Spring进行管理。

详细了解@Bean 注解全解析：https://www.cnblogs.com/cxuanBlog/p/11179439.html

9.@Value

值得注入。经常与Spring EL表达式语言一起使用，注入普通字符，系统属性，表达式运算结果，其他Bean的属性，文件内容，网址请求内容，配置文件属性值等等。
主要两种使用方法：

@Value("#{configProperties['key']}")
@Value("${key}")

10. @PropertySource

指定文件地址。提供一种方便的、声明性的机制，用于向Spring环境添加PropertySource。与@Configuration类一起使用。在app项目中，我们通过@PropertySource注解到JavaConfig类上，设置.properties配置文件的路径。


@Component
@PropertySource(value = "application.properties")
public class Message {

    @Value("${demo.msg}")
    private String msg;

}

11.@ResponseBody

@ResponseBody注解表示该方法的返回的结果直接写入HTTP响应正文中（ResponseBody），一般在异步获取数据时使用，通常是在使用@RequestMapping后。返回值通常解析为跳转路径，加上@ResponseBody后返回结果不会被解析为跳转路径，而是直接写入HTTP响应正文中。

12.@RequestMapping

使用 @RequestMapping 来映射 Request 请求与处理器，通过这个注解可以定义不同的处理器映射规则，即为控制器指定可以处理哪些URL请求。

用@RequestMapping 来映射URL 到控制器类，或者是到Controller 控制器的处理方法上。
当@RequestMapping 标记在Controller类上的时候，里面使用@RequestMapping标记的方法的请求地址都是相对于类上的@RequestMapping 而言的；
当Controller 类上没有标记@RequestMapping 注解时，方法上的@RequestMapping都是绝对路径。这种绝对路径和相对路径所组合成的最终路径都是相对于根路径“/ ”而言的。

13. @SpringBootApplication

@SpringBootApplication是一个组合注解
源码如下：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
  excludeFilters = {
	@Filter(type = FilterType.CUSTOM,classes = {TypeExcludeFilter.class}),    
	@Filter( type = FilterType.CUSTOM,classes = {AutoConfigurationExcludeFilter.class})
  }
)
  public @interface SpringBootApplication {
}

由源码可知，主要包含三个注解@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan。

14. @ComponentScan

@ComponentScan（包扫描）component是组件，scan是扫描，所以这个注解的含义就是用来扫描组件的
ComponentScan就是扫描所标注的类所在包下的所有需要注入的组件，将其注入，这里他是在@SpringBootApplication 中体现的，所以这个注解会自动注入所有在主程序所在包下的组件
以前在ssm项目中我们需要去配置我们的包扫描,相对应的XML配置就是context:component-scan/，将符合条件的组件加入到IOC容器中。

详细了解点击：https://blog.csdn.net/luojinbai/article/details/85877956

15.@EnableAutoConfiguration

@EnableAutoConfiguration表示开启自动装配，注解主要作用从classpath中搜寻所有的META-INF/spring.factories配置文件，并将其中的org.spring-framework.boot.autoconfigure.EnableAutoConfiguration对应的配置项通过反射实例化为对应的标注了@Configuration的javaConfig形式的IOC容器配置类，然后汇总为一整个并加载到IOC容器。

源码如下：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
  String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

  Class<?>[] exclude() default {};

  String[] excludeName() default {};
}

其中两个比较重要的注解@AutoConfigurationPackage与@Import({AutoConfigurationImportSelector.class})

@AutoConfigurationPackage表示获取我们注解所在包下的组件去进行注册
@Import({AutoConfigurationImportSelector.class})表示自动配置导入选择器，从META-INF/spring.factories获取我们的自动配置信息的

较为重要注解以及使用

1. @ConfigurationProperties

将properties属性与一个Bean及其属性相关联，从而实现类型安全的配置。例如：@ConfigurationProperties(prefix="connection")

@Data// lombok注解，相关知识可以自行查阅
@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {

    private String username;
    private String remoteAddress;
    private String password ;

}

详细内容可参考：https://blog.csdn.net/fcvtb/article/details/97488297

2. @ConditionalOnBean与@ConditionalOnMissingBean

@ConditionalOnBean与@ConditionalOnMissingBean两个注解都是条件注解,作用相反。

@ConditionalOnBean表示存当给定的在bean存在时,则实例化当前Bean。
@ConditionalOnMissingBean表示当给定的在bean不存在时,则实例化当前Bean。

@ConditionalOnBean：

结合使用注解@ConditionalOnBean和@Bean,可以做到只有特定名称或者类型的Bean存在于BeanFactory时才创建某个Bean。例如：

@Configuration
public class ConditionalOnBeanConfig {

    @Bean
    public A beanA(){
        return new A(); // 创建一个Bean,名称是 beanA，不需要满足什么前置条件,
    }
    
    @Bean
    @ConditionalOnBean(name="beanA")
    public B beanB(){
	    // 仅在beanFactory存在一个名称叫做beanA的bean时，当前方法初始化一个名字为beanB的bean。
        return new B(); 
    }
    
    @Bean
    @ConditionalOnBean
    public C beanC(){
	    //如果beanFactory不存在一个类型为C的bean，则不创建该bean。
	    // 如果当前项目仅有这一个 bean 配置文件，则因为 beanFactory 中不存在一个类型为C的 bean ，所以当前
	    // 方法定义的名称为 beanC 的 bean 并不会被初始化。
        return new C(); 
    }
    
    @Bean
    public SimpleInt beanAInt(){
	    // 创建一个类型为 SimpleInt 的 bean ，其实现类使用 ASimpleInt
        return new ASimpleInt();
    }
    
    @Bean
    @ConditionalOnBean
    public SimpleInt beanBInt(){
	    // 仅在 beanFactory 中存在一个类型为 SimpleInt 的 bean 时才初始化一个类型同样 为 SimpleInt 
	    // 的 bean ，bean 名称为 beanBInt
        return new BSimpleInt(); 
    }
}

@ConditionalOnMissingBean

配置类中有两个Computer类的bean，一个是笔记本电脑，一个是备用电脑。如果当前容器中已经有电脑bean了，就不注入备用电脑，如果没有，则注入备用电脑，这里需要使用到@ConditionalOnMissingBean。

@Configuration
public class BeanConfig {
 
    @Bean(name = "notebookPC")
    public Computer computer1(){
        return new Computer("笔记本电脑");
    }
 
    @ConditionalOnMissingBean(Computer.class)
    @Bean("reservePC")
    public Computer computer2(){
        return new Computer("备用电脑");
    }
}

3. @ConditionalOnClass与@ConditionalOnMissingClass

@ConditionalOnClass与@ConditionalOnMissingClass这两个注解与@ConditionalOnBean与@ConditionalOnMissingBean两个注解相似。

@ConditionalOnClass 表示当给定的类名在类路径上存在，则实例化当前Bean
@ConditionalOnMissingClass 表示当给定的类名在类路径上不存在，则实例化当前Bean

其他

@ConditionalOnSingleCandidate ： DI容器中该类型Bean只有一个或@Primary的只有一个时起效
@ConditionalOnExpression ： SpEL表达式结果为true时
@ConditionalOnProperty ：参数设置或者值一致时起效
@ConditionalOnResource ：指定的文件存在时起效
@ConditionalOnJndi ：指定的JNDI存在时起效
@ConditionalOnJava ：指定的Java版本存在时起效
@ConditionalOnWebApplication ： Web应用环境下起效
@ConditionalOnNotWebApplication ：非Web应用环境下起效

文章标签： spring