Spring 和 SpringMVC 常用注解（@Autowired@Resource@Component@Repository@Service@Controller的区别）

Posted 2021-06-13 Yan Yang

Spring 常用注解

• 总结内容
• • 一、Spring部分
  • • 1、声明bean的注解
    • 2、注入bean的注解
    • 3、java配置类相关注解
    • 4、切面（AOP）相关注解
    • 5、事务注解
    • 6、@Bean的属性支持
    • 7、@Value注解
    • 8、环境切换
    • 9、异步相关
    • 10、定时任务相关
    • 11、@Enable*注解说明
    • 12、测试相关注解
  • 二、SpringMVC部分
• 总结

总结内容

作者：IT_faquir
原文：https://blog.csdn.net/IT_faquir/article/details/78025203

一、Spring部分

1、声明bean的注解

完成bean的注入（取代 <bean id=“类名小写” class=“类的全限定名”/ >），相当于实例化了一个对应的类，可以给 value 值，如果不给值，默认值为 小写首字母的类名
@Component：组件，没有明确的角色，注入的是 Bean；

@Service：在业务逻辑层使用（service层）；

@Repository：在数据访问层使用（dao层）；

@Controller：在展现层使用，控制器的声明（C）；

需要使用：<context:component-scan base-package=“上面注解的类所在包路径”/>

2、注入bean的注解

完成属性或字段的注入（取代 XML property ref 元素），也就是（<property name=“对应set方法” ref=“引用的 bean id”/ >）相当于用Set方法把 ref 引用的 bean(创建好的实例对象) 设置到注解的对象上
@Autowired：由Spring提供；

@Inject：由JSR-330提供；

@Resource：由JSR-250提供；

都可以注解在set方法和属性上，推荐注解在属性上可以不写 set 方法（一目了然，少写代码）。

• Autowired 注解细节：

1）可以让 Spring 自动的把属性或字段需要的对象找出来，并注入到属性上或字段上。
2）可以贴在字段或者 setter 方法上面。
3）可以同时注入多个对象。
4）可以注入一些 Spring 内置的重要对象，比如 BeanFactory，ApplicationContext 等。
5）默认情况下 Autowired 注解必须要能找到对应的对象，否则报错。通过 required=false 来避免这个问题：@Autowired(required=false)。
6）第三方程序：Spring3.0 之前需要手动配置 Autowired 注解的解析程序： 
    <context:annotation- config/> ，
    在 Spring 的测试环境可以不配置，在 Web 开发中换一种配置解决。
7）Autowired 注解寻找 bean 的方式：
    首先按照依赖对象的类型找，若找到，就是用 setter 或者字段直接注入。
    如果在 Spring 上下文中找到多个匹配的类型，再按照名字去找，若没有匹配报错。
8）可以通过使用 @Qualifier("other") 标签来规定依赖对象按照 bean 的 id 和 类型的组合方式
去找。

• Resource 注解细节：

1）可以让 Spring 自动的把属性或字段需要的对象找出来，并注入到属性上或字段上。
2）可以贴在字段或者 setter 方法上面。
3）可以注入一些 Spring 内置的重要对象，比如 BeanFactory，ApplicationContext 等。
4）Resource 注解必须要能找到对应的对象，否则报错。
5）第三方程序：Spring3.0 之前需要手动配置 Autowired 注解的解析程序： 
    <context:annotation- config/> ，
    在 Spring 的测试环境可以不配置， Web 开发中换一种配置解决。
6）Resource 注解寻找 bean 的方式：
    首先按照名字去找，如果找到，就使用 setter 或者字段注入。
    若按照名字找不到，再按照类型去找，但如果找到多个匹配类型，报错。
7）可以直接使用 name 属性指定 bean 的名称（@Resource(name="")）；但若指定的
name，就只能按照 name 去找，若找不到，就不会再按照类型去。

3、java配置类相关注解

@Configuration：声明当前类为配置类，相当于xml形式的Spring配置（类上）

@Bean：注解在方法上，声明当前方法的返回值为一个bean，替代xml中的方式（方法上）

@Configuration：声明当前类为配置类，其中内部组合了@Component注解，表明这个类是一个bean（类上）

@ComponentScan：用于对Component进行扫描，相当于xml中的扫描（类上）

@WishlyConfiguration：为@Configuration与@ComponentScan的组合注解，可以替代这两个注解

4、切面（AOP）相关注解

Spring支持AspectJ的注解式切面编程。

@Aspect：声明一个切面（类上）
使用@After、@Before、@Around定义建言（advice），可直接将拦截规则（切点）作为参数。
@After：在方法执行之后执行（方法上）
@Before：在方法执行之前执行（方法上）
@Around：在方法执行之前与之后执行（方法上）
@PointCut：声明切点

在java配置类中使用@EnableAspectJAutoProxy：注解开启Spring对AspectJ代理的支持（类上）
也可以在配置文件中配置：

<aop:aspectj-autoproxy/>

5、事务注解

@Transactional：贴在方法或类上

<tx:annotation-driven/>

6、@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

7、@Value注解

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

1. 注入普通字符

@Value("Michael Jackson")
String name;

2. 注入操作系统属性

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

3. 注入表达式结果

@Value("#{ T(java.lang.Math).random() * 100 }")  
String randomNumber;

4. 注入其它bean属性

@Value("#{domeClass.name}")</font>
String name;

5. 注入文件资源

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

6. 注入网站资源

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

7. 注入配置文件

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

8. 注入配置使用方法：
   ① 编写配置文件（test.properties）
   book.name=《三体》
   ② @PropertySource 加载配置文件(类上@PropertySource(“classpath:com/hgs/hello/test/test.propertie”)
   ③ 还需配置一个PropertySourcesPlaceholderConfigurer的bean

8、环境切换

@Profile：通过设定Environment的ActiveProfiles来设定当前context需要使用的配置环境。（类或方法上）

@Conditional：Spring4中可以使用此注解定义条件话的bean，通过实现Condition接口，并重写matches方法，从而决定该bean是否被实例化。（方法上）

9、异步相关

@EnableAsync：配置类中，通过此注解开启对异步任务的支持，叙事性AsyncConfigurer接口（类上）

@Async：在实际执行的bean方法使用该注解来申明其是一个异步任务（方法上或类上所有的方法都将异步，需要@EnableAsync开启异步任务）

10、定时任务相关

@EnableScheduling：在配置类上使用，开启计划任务的支持（类上）

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

11、@Enable*注解说明

这些注解主要用来开启对xxx的支持。
@EnableAspectJAutoProxy：开启对AspectJ自动代理的支持

@EnableAsync：开启异步方法的支持

@EnableScheduling：开启计划任务的支持

@EnableWebMvc：开启Web MVC的配置支持

@EnableConfigurationProperties：开启对@ConfigurationProperties注解配置Bean的支持

@EnableJpaRepositories：开启对SpringData JPA Repository的支持

@EnableTransactionManagement：开启注解式事务的支持

@EnableTransactionManagement：开启注解式事务的支持

@EnableCaching：开启注解式的缓存支持

12、测试相关注解

@RunWith：运行器，Spring中通常用于对JUnit的支持

@ContextConfiguration：用来加载配置ApplicationContext，其中classes属性用来加载配置类

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes={TestConfig.class})
public class KjtTest {
    private static Logger logger = LoggerFactory.getLogger("KjtTest");
    @Autowired
    Service service;
    @Test
    public void test() { 
    }
}

二、SpringMVC部分

@EnableWebMvc：在配置类中开启Web MVC的配置支持，如一些ViewResolver或者MessageConverter等，若无此句，重写WebMvcConfigurerAdapter方法（用于对SpringMVC的配置）。

@Controller：声明该类为SpringMVC中的Controller

@RequestMapping：用于映射Web请求，包括访问路径和参数（类或方法上）

@ResponseBody：支持将返回值放在response内，而不是一个页面，通常用户返回json数据（返回值旁或方法上）

@RequestBody：允许request的参数在request体中，而不是在直接连接在地址后面。（放在参数前）

@PathVariable：用于接收路径参数，比如@RequestMapping(“/hello/{name}”)申明的路径，将注解放在参数中前，即可获取该值，通常作为Restful的接口实现方法。

@RestController：该注解为一个组合注解，相当于@Controller和@ResponseBody的组合，注解在类上，意味着，该Controller的所有方法都默认加上了@ResponseBody。

@ControllerAdvice：通过该注解，我们可以将对于控制器的全局配置放置在同一个位置，注解了@Controller的类的方法可使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上，
这对所有注解了 @RequestMapping的控制器内的方法有效。

@ExceptionHandler：用于全局处理控制器里的异常

@InitBinder：用来设置WebDataBinder，WebDataBinder用来自动绑定前台请求参数到Model中。

@ModelAttribute：本来的作用是绑定键值对到Model里，在@ControllerAdvice中是让全局的@RequestMapping都能获得在此处设置的键值对。

如有遗漏或有误的地方，希望帮忙指出。

总结

以上就是对 Spring 和 SpringMVC 常用注解常用注解的总结了，代码仅供参考，欢迎讨论交流。