Spring--Spring 注解大全与详解

落日映苍穹つ 2023-06-25 06:02 12阅读 0赞

# Spring使用的注解大全和解释 #

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>解释</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Controller</td> 
   <td>组合注解（组合了@Component注解），应用在MVC层（控制层）,DispatcherServlet会自动扫描注解了此注解的类，然后将web请求映射到注解了@RequestMapping的方法上。</td> 
  </tr> 
  <tr> 
   <td>@Service</td> 
   <td>组合注解（组合了@Component注解），应用在service层（业务逻辑层）</td> 
  </tr> 
  <tr> 
   <td>@Reponsitory</td> 
   <td>组合注解（组合了@Component注解），应用在dao层（数据访问层）</td> 
  </tr> 
  <tr> 
   <td>@Component</td> 
   <td>表示一个带注释的类是一个“组件”，成为Spring管理的Bean。当使用基于注解的配置和类路径扫描时，这些类被视为自动检测的候选对象。同时@Component还是一个元注解。</td> 
  </tr> 
  <tr> 
   <td>@Autowired</td> 
   <td>Spring提供的工具（由Spring的依赖注入工具（BeanPostProcessor、BeanFactoryPostProcessor）自动注入。）</td> 
  </tr> 
  <tr> 
   <td>@Resource</td> 
   <td>JSR-250提供的注解</td> 
  </tr> 
  <tr> 
   <td>@Inject</td> 
   <td>JSR-330提供的注解</td> 
  </tr> 
  <tr> 
   <td>@Configuration</td> 
   <td>声明当前类是一个配置类（相当于一个Spring配置的xml文件）</td> 
  </tr> 
  <tr> 
   <td>@ComponentScan</td> 
   <td>自动扫描指定包下所有使用@Service,@Component,@Controller,@Repository的类并注册</td> 
  </tr> 
  <tr> 
   <td>@Bean</td> 
   <td>注解在方法上，声明当前方法的返回值为一个Bean。返回的Bean对应的类中可以定义init()方法和destroy()方法，然后在@Bean(initMethod=”init”,destroyMethod=”destroy”)定义，在构造之后执行init，在销毁之前执行destroy。</td> 
  </tr> 
  <tr> 
   <td>@Aspect</td> 
   <td>声明一个切面（就是说这是一个额外功能）</td> 
  </tr> 
  <tr> 
   <td>@After</td> 
   <td>后置建言（advice），在原方法前执行。</td> 
  </tr> 
  <tr> 
   <td>@Before</td> 
   <td>前置建言（advice），在原方法后执行。</td> 
  </tr> 
  <tr> 
   <td>@Around</td> 
   <td>环绕建言（advice），在原方法执行前执行，在原方法执行后再执行（@Around可以实现其他两种advice）</td> 
  </tr> 
  <tr> 
   <td>@PointCut</td> 
   <td>声明切点，即定义拦截规则，确定有哪些方法会被切入</td> 
  </tr> 
  <tr> 
   <td>@Transactional</td> 
   <td>声明事务（一般默认配置即可满足要求，当然也可以自定义）</td> 
  </tr> 
  <tr> 
   <td>@Cacheable</td> 
   <td>声明数据缓存</td> 
  </tr> 
  <tr> 
   <td>@EnableAspectJAutoProxy</td> 
   <td>开启Spring对AspectJ的支持</td> 
  </tr> 
  <tr> 
   <td>@Value</td> 
   <td>值得注入。经常与Sping EL表达式语言一起使用，注入普通字符，系统属性，表达式运算结果，其他Bean的属性，文件内容，网址请求内容，配置文件属性值等等</td> 
  </tr> 
  <tr> 
   <td>@PropertySource</td> 
   <td>指定文件地址。提供了一种方便的、声明性的机制，用于向Spring的环境添加PropertySource。与@configuration类一起使用。</td> 
  </tr> 
  <tr> 
   <td>@PostConstruct</td> 
   <td>标注在方法上，该方法在构造函数执行完成之后执行。</td> 
  </tr> 
  <tr> 
   <td>@PreDestroy</td> 
   <td>标注在方法上，该方法在对象销毁之前执行。</td> 
  </tr> 
  <tr> 
   <td>@Profile</td> 
   <td>表示当一个或多个指定的文件是活动的时，一个组件是有资格注册的。使用@Profile注解类或者方法，达到在不同情况下选择实例化不同的Bean。@Profile(“dev”)表示为dev时实例化。</td> 
  </tr> 
  <tr> 
   <td>@EnableAsync</td> 
   <td>开启异步任务支持。注解在配置类上。</td> 
  </tr> 
  <tr> 
   <td>@Async</td> 
   <td>注解在方法上标示这是一个异步方法，在类上标示这个类所有的方法都是异步方法。</td> 
  </tr> 
  <tr> 
   <td>@EnableScheduling</td> 
   <td>注解在配置类上，开启对计划任务的支持。</td> 
  </tr> 
  <tr> 
   <td>@Scheduled</td> 
   <td>注解在方法上，声明该方法是计划任务。支持多种类型的计划任务：cron,fixDelay,fixRate</td> 
  </tr> 
  <tr> 
   <td>@Conditional</td> 
   <td>根据满足某一特定条件创建特定的Bean</td> 
  </tr> 
  <tr> 
   <td>@Enable*</td> 
   <td>通过简单的@Enable*来开启一项功能的支持。所有@Enable*注解都有一个@Import注解，@Import是用来导入配置类的，这也就意味着这些自动开启的实现其实是导入了一些自动配置的Bean(1.直接导入配置类2.依据条件选择配置类3.动态注册配置类)</td> 
  </tr> 
  <tr> 
   <td>@RunWith</td> 
   <td>这个是Junit的注解，springboot集成了junit。一般在测试类里使用:@RunWith(SpringJUnit4ClassRunner.class) — SpringJUnit4ClassRunner在JUnit环境下提供Sprng TestContext Framework的功能</td> 
  </tr> 
  <tr> 
   <td>@ContextConfiguration</td> 
   <td>用来加载配置ApplicationContext，其中classes属性用来加载配置类:@ContextConfiguration(classes = {TestConfig.class(自定义的一个配置类)})</td> 
  </tr> 
  <tr> 
   <td>@ActiveProfiles</td> 
   <td>用来声明活动的profile–@ActiveProfiles(“prod”(这个prod定义在配置类中))</td> 
  </tr> 
  <tr> 
   <td>@EnableWebMvc</td> 
   <td>用在配置类上，开启SpringMvc的Mvc的一些默认配置：如ViewResolver，MessageConverter等。同时在自己定制SpringMvc的相关配置时需要做到两点：1.配置类继承WebMvcConfigurerAdapter类2.就是必须使用这个@EnableWebMvc注解。</td> 
  </tr> 
  <tr> 
   <td>@RequestMapping</td> 
   <td>用来映射web请求（访问路径和参数），处理类和方法的。可以注解在类和方法上，注解在方法上的@RequestMapping路径会继承注解在类上的路径。同时支持Serlvet的request和response作为参数，也支持对request和response的媒体类型进行配置。其中有value(路径)，produces(定义返回的媒体类型和字符集)，method(指定请求方式)等属性。</td> 
  </tr> 
  <tr> 
   <td>@ResponseBody</td> 
   <td>将返回值放在response体内。返回的是数据而不是页面</td> 
  </tr> 
  <tr> 
   <td>@RequestBody</td> 
   <td>允许request的参数在request体中，而不是在直接链接在地址的后面。此注解放置在参数前。</td> 
  </tr> 
  <tr> 
   <td>@PathVariable</td> 
   <td>放置在参数前，用来接受路径参数。</td> 
  </tr> 
  <tr> 
   <td>@RestController</td> 
   <td>组合注解，组合了@Controller和@ResponseBody,当我们只开发一个和页面交互数据的控制层的时候可以使用此注解。</td> 
  </tr> 
  <tr> 
   <td>@ControllerAdvice</td> 
   <td>用在类上，声明一个控制器建言，它也组合了@Component注解，会自动注册为Spring的Bean。</td> 
  </tr> 
  <tr> 
   <td>@ExceptionHandler</td> 
   <td>用在方法上定义全局处理，通过他的value属性可以过滤拦截的条件：@ExceptionHandler(value=Exception.class)–表示拦截所有的Exception。</td> 
  </tr> 
  <tr> 
   <td>@ModelAttribute</td> 
   <td>将键值对添加到全局，所有注解了@RequestMapping的方法可获得次键值对（就是在请求到达之前，往model里addAttribute一对name-value而已）。</td> 
  </tr> 
  <tr> 
   <td>@InitBinder</td> 
   <td>通过@InitBinder注解定制WebDataBinder（用在方法上，方法有一个WebDataBinder作为参数，用WebDataBinder在方法内定制数据绑定，例如可以忽略request传过来的参数Id等）。</td> 
  </tr> 
  <tr> 
   <td>@WebAppConfiguration</td> 
   <td>一般用在测试上，注解在类上，用来声明加载的ApplicationContext是一个WebApplicationContext。他的属性指定的是Web资源的位置，默认为src/main/webapp,我们可以修改为：@WebAppConfiguration(“src/main/resources”)。</td> 
  </tr> 
  <tr> 
   <td>@EnableAutoConfiguration</td> 
   <td>此注释自动载入应用程序所需的所有Bean——这依赖于Spring Boot在类路径中的查找。该注解组合了@Import注解，@Import注解导入了EnableAutoCofigurationImportSelector类，它使用SpringFactoriesLoader.loaderFactoryNames方法来扫描具有META-INF/spring.factories文件的jar包。而spring.factories里声明了有哪些自动配置。</td> 
  </tr> 
  <tr> 
   <td>@SpingBootApplication</td> 
   <td>SpringBoot的核心注解，主要目的是开启自动配置。它也是一个组合注解，主要组合了@Configurer，@EnableAutoConfiguration（核心）和@ComponentScan。可以通过@SpringBootApplication(exclude={想要关闭的自动配置的类名.class})来关闭特定的自动配置。</td> 
  </tr> 
  <tr> 
   <td>@ImportResource</td> 
   <td>虽然Spring提倡零配置，但是还是提供了对xml文件的支持，这个注解就是用来加载xml配置的。例：@ImportResource({“classpath</td> 
  </tr> 
  <tr> 
   <td>@ConfigurationProperties</td> 
   <td>将properties属性与一个Bean及其属性相关联，从而实现类型安全的配置。例：@ConfigurationProperties(prefix=”authot”，locations={“classpath</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnBean</td> 
   <td>条件注解。当容器里有指定Bean的条件下。</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnClass</td> 
   <td>条件注解。当类路径下有指定的类的条件下。</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnExpression</td> 
   <td>条件注解。基于SpEL表达式作为判断条件。</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnJava</td> 
   <td>条件注解。基于JVM版本作为判断条件。</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnJndi</td> 
   <td>条件注解。在JNDI存在的条件下查找指定的位置。</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnMissingBean</td> 
   <td>条件注解。当容器里没有指定Bean的情况下。</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnMissingClass</td> 
   <td>条件注解。当类路径下没有指定的类的情况下。</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnNotWebApplication</td> 
   <td>条件注解。当前项目不是web项目的条件下。</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnResource</td> 
   <td>条件注解。类路径是否有指定的值。</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnSingleCandidate</td> 
   <td>条件注解。当指定Bean在容器中只有一个，后者虽然有多个但是指定首选的Bean。</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnWebApplication</td> 
   <td>条件注解。当前项目是web项目的情况下。</td> 
  </tr> 
  <tr> 
   <td>@EnableConfigurationProperties</td> 
   <td>注解在类上，声明开启属性注入，使用@Autowired注入。例：@EnableConfigurationProperties(HttpEncodingProperties.class)。</td> 
  </tr> 
  <tr> 
   <td>@AutoConfigureAfter</td> 
   <td>在指定的自动配置类之后再配置。例：@AutoConfigureAfter(WebMvcAutoConfiguration.class)</td> 
  </tr> 
 </tbody> 
</table>