一文总结Spring 注解及作用详解

文章目录

开启注解扫描配置
@RequestMapping
声明bean的注解
注入bean的注解
spring配置文件中读取properties配置文件
j配置类相关注解
切面（AOP）相关注解
@Bean的属性支持
@Value注解
环境切换
异步相关
定时任务相关
@Enable*注解说明
测试相关注解

开启注解扫描配置

 <!--开启注解扫描-->
  <context:component-scan base-package="com"/>

@RequestMapping

@RequestMapping 是用来处理请求地址映射的注解，可用于类或方法上。用在类上，表示类中所有的响应的方法都是以该地址作为父路径来访问，用在方法上表示该方法的访问的路径；两者结合起来的访问的路径为完整的访问某个方法的路径。

@RequestMapping 注解的属性：

value：指定请求的实际的地址，指定的地址可以是 URI Template 模式；
method：指定访问的方法
consumes：指定处理请求的内容类型，比如 aplication/json;text/html
produces：指定返回的内容的类型
params：指定 request 中必须包含某些参数值时，才让该方法处理请求
headers：指定 request 中必须包含指定的 header 值，才能让该方法处理请求

RequestParam：用于将指定的请求参数赋给方法中的形参
Required：负责检查一个bean在初始化时其声明的set方法是否被执行，当某个被标注了 @Required的 Setter方法没有被调用，则 Spring在解析的时候会抛出异常，以提醒开发者对相应属性进行设置。 @Required注解只能标注在 Setter方法之上。
@EnableSwagger2Doc ：通过这种注解来生成对应的API文档
@Primary ：当存在多个相同类型的Bean，例如，多个DataSource，多个JdbcTemplate时，强烈建议总是使用@Primary把其中某一个Bean标识为“主要的”，使用@Autowired注入时会首先使用被标记为@Primary的Bean。
@CrossOrigin(origins = “*”, maxAge = 3600) 跨域
@Transactional @Transactional(rollbackFor=Exception.class)出现异常也回滚 @Transactional(noRolbackFor=Exception.class)出现异常也不会回滚

声明bean的注解

@Component

作用：把当前类对象存入Spring容器中，相当于在 xml 中配置一个 bean。
属性：value：指定 bean 的 id。如果不指定 value 属性，默认 bean 的 id 是当前类的类名且首字母小写。

@Controller @Service @Repository

三个注解都是针对一个@Component 的衍生注解，他们的作用及属性都是一模一样的。只不过是提供了更加明确的语义化。
@Respository：标识持久层，数据访问组件，即 DAO 组件
@Service：标识业务层组件
@Controller ：标识表现层,控制层组件

相当于XML配置的

<bean id="" class="">

注入bean的注解

@Resource 和@Autowired

@Resource 和@Autowired 都是做 bean 的注入时使用,都可以写在字段上，或者是 setter 方法上 @Autowired 注解是按照类型（byType）装配依赖对象（由 Spring 提供）如果在此基础上想通过 byName 来装配，可以结合@Qualifier 注解来一起使用。 @Resource 默认按照 byName 自动注入

@Resource 有两个重要的属性，name 和 type

@Resource 如果写属性 name，则按照 byName 来装配，如果属性为 type，则按照 byType 来装配，不写按照默认的方式来装配（byName）

@Autowired @Qualifier 与 @Resource

用法：标注在成员变量上，或者set方法上。@Autowired 与 @Resource 都是用于bean自动装配的
区别：@Autowired装配默认是通过类型去查找，也可以通过@Qualifier指定名称查找。而@Resource 默认按照名称进行查找，当然也可指定类型、指定名称或者同时指定。指定类型的时候如果找不到或者找到多个都会抛出异常。同时指定类型和名称的时候，会去找唯一匹配的bean，如果找到多个抛出异常。

spring配置文件中读取properties配置文件

a. 使用PropertyPlaceholderConfigure 读取配置文件

<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
       <!--注入外部配置文件位置-->
       <property name="location"  value="classpath:db.properties" />
</bean>

b. 读取方式

<context:property-placeholder location="classpath:db.properties" />

j配置类相关注解

@Configuration 声明当前类为配置类，相当于xml形式的Spring配置（类上）
@Bean 注解在方法上，声明当前方法的返回值为一个bean，替代xml中的方式（方法上）
@Configuration 声明当前类为配置类，其中内部组合了@Component注解，表明这个类是一个bean（类上）
@ComponentScan 用于对Component进行扫描，相当于xml中的context:component-scan/（类上）
@WishlyConfiguration 为@Configuration与@ComponentScan的组合注解，可以替代这两个注解

切面（AOP）相关注解

Spring支持AspectJ的注解式切面编程。
@Aspect 声明一个切面（类上）
- 使用@After、@Before、@Around定义建言（advice），可直接将拦截规则（切点）作为参数。
@After 在方法执行之后执行（方法上）
@Before 在方法执行之前执行（方法上）
@Around 在方法执行之前与之后执行（方法上）
@PointCut 声明切点
- 在java配置类中使用@EnableAspectJAutoProxy注解开启Spring对AspectJ代理的支持（类上）

@Bean的属性支持

@Scope 设置Spring容器如何新建Bean实例（方法上，得有@Bean）

设置类型包括

Singleton （单例,一个Spring容器中只有一个bean实例，默认模式）,
Protetype （每次调用新建一个bean）,
Request （web项目中，给每个http request新建一个bean）,
Session （web项目中，给每个http session新建一个bean）,
GlobalSession（给每一个 global http session新建一个Bean实例）

@StepScope 在Spring Batch中还有涉及

@PostConstruct 由JSR-250提供，在构造函数执行完之后执行，等价于xml配置文件中bean的initMethod

@PreDestory 由JSR-250提供，在Bean销毁之前执行，等价于xml配置文件中bean的destroyMethod

@Value注解

@Value 为属性注入值（属性上）
支持如下方式的注入：

注入普通字符

@Value("Michael Jackson")
String name;

注入操作系统属性

@Value("#{systemProperties['os.name']}")
String osName;

注入表达式结果

@Value("#{systemProperties['os.name']}")
String osName;

注入其它bean属性

@Value("#{domeClass.name}")
String name;

注入文件资源

@Value("classpath:com/hgs/hello/test.txt")
String Resource file;

注入网站资源

@Value("http://www.cznovel.com")
Resource url;

注入配置文件

@Value("${book.name}")
String bookName;

注入配置使用方法

① 编写配置文件（test.properties）

book.name=《活着》

② @PropertySource 加载配置文件(类上)

@PropertySource("classpath:dp.propertie")

③ 还需配置一个PropertySourcesPlaceholderConfigurer的bean。

环境切换

@Profile 通过设定Environment的ActiveProfiles来设定当前context需要使用的配置环境。（类或方法上）
@Conditional Spring4中可以使用此注解定义条件话的bean，通过实现Condition接口，并重写matches方法，从而决定该bean是否被实例化。（方法上）

异步相关

@EnableAsync 配置类中，通过此注解开启对异步任务的支持，叙事性AsyncConfigurer接口（类上）
@Async 在实际执行的bean方法使用该注解来申明其是一个异步任务（方法上或类上所有的方法都将异步，需要@EnableAsync开启异步任务）

定时任务相关

@EnableScheduling 在配置类上使用，开启计划任务的支持（类上）
@Scheduled 来申明这是一个任务，包括cron,fixDelay,fixRate等类型（方法上，需先开启计划任务的支持）

@Enable*注解说明

这些注解主要用来开启对xxx的支持。

@EnableAspectJAutoProxy 开启对AspectJ自动代理的支持
@EnableAsync 开启异步方法的支持
@EnableScheduling 开启计划任务的支持
@EnableWebMvc 开启Web MVC的配置支持
@EnableConfigurationProperties 开启对@ConfigurationProperties注解配置Bean的支持
@EnableJpaRepositories 开启对SpringData JPA Repository的支持
@EnableTransactionManagement 开启注解式事务的支持
@EnableTransactionManagement 开启注解式事务的支持
@EnableCaching 开启注解式的缓存支持

测试相关注解

@RunWith 运行器，Spring中通常用于对JUnit的支持
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration 用来加载配置ApplicationContext，其中classes属性用来加载配置类
@ContextConfiguration(classes={TestConfig.class})

你知道的越多，你不知道的越多。
有道无术，术尚可求，有术无道，止于术。
如有其它问题，欢迎大家留言，我们一起讨论，一起学习，一起进步

斗士（Carroll）

发布了193 篇原创文章 · 获赞 116 · 访问量 1万+

私信关注