整理：Springboot的注解与说明

你的名字 2022-01-14 12:37 272阅读 0赞

> 文章大部分来源https://blog.csdn.net/weixin\_41662670/article/details/79649899

声明bean的注解

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><span style="color:#7c79e5;"><strong>@Component</strong></span></td> 
   <td>没有明确的对应</td> 
  </tr> 
  <tr> 
   <td><span style="color:#7c79e5;"><strong>@Service</strong></span></td> 
   <td>@Component的派生子类，在<span style="color:#f33b45;">业务逻辑</span>层(service层)使用</td> 
  </tr> 
  <tr> 
   <td><span style="color:#7c79e5;"><strong>@Repository</strong></span></td> 
   <td>@Component的派生子类，在<span style="color:#f33b45;">数据访问</span>层(dao层)使用.</td> 
  </tr> 
  <tr> 
   <td><span style="color:#7c79e5;"><strong>@Controller</strong></span></td> 
   <td>@Component的派生子类，在<span style="color:#f33b45;">控制层</span>(controller/web)层使用</td> 
  </tr> 
 </tbody> 
</table>

## 注入bean的注解 ##

<table> 
 <thead> 
  <tr> 
   <th style="width:94px;">注解</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="width:94px;">@Inject</td> 
   <td>1、@Inject是JSR330 (Dependency Injection for Java)中的规范，需要导入javax.inject.Inject;实现注入。<br> 2、@Inject是根据类型进行自动装配的，如果需要按名称进行装配，则需要配合@Named；<br> 3、@Inject可以作用在变量、setter方法、构造函数上</td> 
  </tr> 
  <tr> 
   <td style="width:94px;">@Named</td> 
   <td>@Named("XXX") 中的 XX是 Bean 的名称，所以 @Inject和 @Named结合使用时，自动注入的策略就从 byType 转变成 byName 了。</td> 
  </tr> 
  <tr> 
   <td style="width:94px;"><strong><span style="color:#7c79e5;">@Autowired</span></strong></td> 
   <td>1、@Autowired是spring自带的注解，通过‘AutowiredAnnotationBeanPostProcessor’ 类实现的依赖注入<br> 2、@Autowired是根据类型进行自动装配的，如果需要按名称进行装配，则需要配合@Qualifier<br> 3、@Autowired有个属性为required，可以配置为false，如果配置为false之后，当没有找到相应bean的时候，系统不会抛错<br> 4、@Autowired可以作用在变量、setter方法、构造函数上</td> 
  </tr> 
  <tr> 
   <td style="width:94px;">@Qualifier</td> 
   <td>@Qualifier("XXX") 中的 XX是 Bean 的名称，所以 @Autowired 和 @Qualifier 结合使用时，自动注入的策略就从 byType 转变成 byName 了。</td> 
  </tr> 
  <tr> 
   <td style="width:94px;">@Qualifier</td> 
   <td>@Qualifier("XXX") 中的 XX是 Bean 的名称，所以 @Autowired 和 @Qualifier 结合使用时，自动注入的策略就从 byType 转变成 byName 了。不过需要注意的是@Autowired 可以对成员变量、方法以及构造函数进行注释，而 @Qualifier 的标注对象是成员变量、方法入参、构造函数入参。</td> 
  </tr> 
  <tr> 
   <td style="width:94px;"><strong><span style="color:#7c79e5;">@Resource</span></strong></td> 
   <td>1、@Resource是JSR250规范的实现，需要导入javax.annotation实现注入。<br> 2、@Resource是根据名称进行自动装配的，一般会指定一个name属性3、@Resource可以作用在变量、setter方法上。</td> 
  </tr> 
 </tbody> 
</table>

## 配置文件的注解 ##

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong><span style="color:#7c79e5;">@Configuration</span></strong></td> 
   <td>声明配置类，相等于xml配置文件</td> 
  </tr> 
  <tr> 
   <td><strong><span style="color:#7c79e5;">@ComponentScan (com.lifeibai)</span></strong></td> 
   <td>自动扫描包及子包的所有 @Component @Service @Repository @Controller 的类,并注册为Bean</td> 
  </tr> 
  <tr> 
   <td><strong><span style="color:#7c79e5;">@WiselyConfiguration</span></strong></td> 
   <td>组合注解 可以替代 @Configuration和@ComponentScan</td> 
  </tr> 
  <tr> 
   <td><strong><span style="color:#7c79e5;">@Bean</span></strong></td> 
   <td>用在方法上，声明为一个bean，不写的值的话，默认bean的名称为方法名称</td> 
  </tr> 
 </tbody> 
</table>

## AOP切面编程注解 ##

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Aspect</td> 
   <td>声明这是一个切面</td> 
  </tr> 
  <tr> 
   <td>@After @Before. @Around</td> 
   <td>定义切面,可以直接将拦截规则(切入点 PointCut)作为参数</td> 
  </tr> 
  <tr> 
   <td>@PointCut</td> 
   <td>专门定义拦截规则 然后在 @After @Before. @Around 中调用</td> 
  </tr> 
  <tr> 
   <td><strong><span style="color:#3399ea;">@Transcational</span></strong></td> 
   <td>事务处理</td> 
  </tr> 
  <tr> 
   <td>@Cacheable</td> 
   <td>数据缓存</td> 
  </tr> 
  <tr> 
   <td>@EnableAaspectJAutoProxy</td> 
   <td>开启Spring 对 这个切面(Aspect )的支持</td> 
  </tr> 
  <tr> 
   <td>@Target (ElementType.TYPE)</td> 
   <td>元注解,用来指定注解修饰类的那个成员 --&gt;指定拦截规则</td> 
  </tr> 
  <tr> 
   <td>@Retention(RetentionPolicy.RUNTIME)</td> 
   <td>当定义的注解的@Retention为RUNTIME时，才能够通过运行时的反射机制来处理注解.--&gt;指定拦截规则</td> 
  </tr> 
 </tbody> 
</table>

## Spring 常用配置 ##

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@import</td> 
   <td>导入配置类</td> 
  </tr> 
  <tr> 
   <td><strong><span style="color:#7c79e5;">@Scope</span></strong></td> 
   <td>新建Bean的实例</td> 
  </tr> 
  <tr> 
   <td>@PostConstruct</td> 
   <td>在构造函数执行完之后执行</td> 
  </tr> 
  <tr> 
   <td>@PreDestroy</td> 
   <td>在 Bean 销毁之前执行</td> 
  </tr> 
  <tr> 
   <td>@ActiveProfiles</td> 
   <td>用来声明活动的 profile</td> 
  </tr> 
  <tr> 
   <td>@profile</td> 
   <td>为不同环境下使用不同的配置提供了支持<br> @Profile("dev") .......对方法名为 dev-xxxx的方法提供实例化Bean</td> 
  </tr> 
  <tr> 
   <td><span style="color:#7c79e5;"><strong>@EnableAsync</strong></span></td> 
   <td>开启异步任务的支持(多线程)</td> 
  </tr> 
  <tr> 
   <td>@Asyns</td> 
   <td>声明这是一个异步任务,可以在类级别 和方法级别声明.</td> 
  </tr> 
  <tr> 
   <td>@EnableScheduling</td> 
   <td>开启对计划任务的支持(定时器)</td> 
  </tr> 
  <tr> 
   <td>@Scheduled</td> 
   <td>声明这是一个计划任务 支持多种计划任务,包含 cron. fixDelay fixRate<br> @Scheduled (dixedDelay = 5000) 通过注解 定时更新</td> 
  </tr> 
  <tr> 
   <td>@Conditional</td> 
   <td>条件注解,根据满足某一特定条件创建一个特定的Bean</td> 
  </tr> 
  <tr> 
   <td>@WebAppCofiguration</td> 
   <td>指定加载 ApplicationContext是一个WebApplicationContext</td> 
  </tr> 
  <tr> 
   <td>@ContextConfiguration</td> 
   <td>加载配置文件@ContextConfiguration(classes = {TestConfig.class})@ContextConfiguration用来加载ApplicationContext classes属性用来加载配置类</td> 
  </tr> 
  <tr> 
   <td><strong><span style="color:#7c79e5;">@Value</span></strong></td> 
   <td>放置在字段、方法和方法/构造函数参数上，以指定默认值。 <p>&nbsp;</p> <p>&nbsp;</p> <pre><code>@Value("字符串") --&gt;注入字符串
@Vaule("#{systemProperties['os.name']}")--&gt;注入操作系统属性
@Value ("#{ T (java.lang.Math).random() &nbsp;* 100.0 }") --&gt; 注入表达式结果  @Value ("#{demoService.another}") --&gt; 注入其他Bean属性  @Value ( "classpath:com/wisely/highlight_spring4/ch2/el/test.txt" ) &nbsp; &nbsp; 注入文件资源  @Value ("http://www.baidu.com")--&gt;注入网址资源  @Value ("${book.name}" ) --&gt; 注入配置文件 &nbsp;注意: 使用的是$ 而不是 # </code></pre> <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

##    @Enable\*注解 ##

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@EnableAsync</td> 
   <td>开启异步任务的支持(多线程)</td> 
  </tr> 
  <tr> 
   <td>@EnableScheduling</td> 
   <td>开启对计划任务的支持(定时器)</td> 
  </tr> 
  <tr> 
   <td>@EnableWebMVC</td> 
   <td>开启对Web MVC 的配置支持</td> 
  </tr> 
  <tr> 
   <td>@EnableAaspectJAutoProxy</td> 
   <td>开启Spring 对 这个切面(Aspect )的支持</td> 
  </tr> 
  <tr> 
   <td>@EnableConfigurationProperties</td> 
   <td>开启对@ConfigurationProperties注解配置Bean的支持</td> 
  </tr> 
  <tr> 
   <td>@EnableJpaRepositories</td> 
   <td>开启对Spring Data JAP Repository 的支持</td> 
  </tr> 
  <tr> 
   <td>@EnableTransactionManagement</td> 
   <td>开启对注解式事物的支持</td> 
  </tr> 
  <tr> 
   <td>@EnableCaching</td> 
   <td>开启注解是缓存的支持.</td> 
  </tr> 
  <tr> 
   <td>@EnableDiscoveryClient</td> 
   <td>让服务发现服务器,使用服务器.Spring cloud 实现服务发现</td> 
  </tr> 
  <tr> 
   <td>@EnableEurekaServer</td> 
   <td>注册服务器 spring cloud 实现服务注册</td> 
  </tr> 
  <tr> 
   <td>@EnableScheduling</td> 
   <td>让spring可以进行任务调度,功能类似于spring.xml文件中的命名空间</td> 
  </tr> 
  <tr> 
   <td>@EnableCaching</td> 
   <td>开启Cache缓存支持</td> 
  </tr> 
 </tbody> 
</table>

## springboot注解 ##

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong><span style="color:#7c79e5;">@SpringBootConfiguration</span></strong></td> 
   <td>包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。</td> 
  </tr> 
  <tr> 
   <td>@EnableAutoConfiguration</td> 
   <td>自动配置</td> 
  </tr> 
  <tr> 
   <td>@ComponentScan</td> 
   <td>让spring Boot扫描到Configuration类并把它加入到程序上下文</td> 
  </tr> 
  <tr> 
   <td>@PropertySource</td> 
   <td>是spring3.1开始引入的基于java config的注解。<br> 通过@PropertySource注解将properties配置文件中的值存储到Spring的 Environment中，Environment接口提供方法去读取配置文件中的值，参数是properties文件中定义的key值。</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>@ConditionalOnProperty</td> 
   <td>指定的属性是否具有指定的值</td> 
  </tr> 
  <tr> 
   <td>@ConditionalOnResourcce</td> 
   <td>类路径下是否有指定的值</td> 
  </tr> 
 </tbody> 
</table>