Spring 各种注解备注

Z时代
2024-01-10
分类：综合

本文内容纲要：

- Spring 各种注解备注

Spring 各种注解备注

felix_feng 关注

2016.12.28 10:34* 字数 2092 阅读 790评论 0喜欢 6

转载（http://blog.csdn.net/sudiluo_java/article/details/51858978）

@ConditionalOnBean 配置了某个特定Bean

@ConditionalOnMissingBean 没有配置特定的Bean

@ConditionalOnClass Classpath里有指定的类

@ConditionalOnMissingClass Classpath里缺少指定的类

@ConditionalOnExpression 给定的Spring Expression Language（SpEL）表达式计算结果为true

@ConditionalOnJava Java的版本匹配特定值或者一个范围值

@ConditionalOnJndi 参数中给定的JNDI位置必须存在一个，如果没有给参数，则要有JNDI

InitialContext

@ConditionalOnProperty 指定的配置属性要有一个明确的值

@ConditionalOnResource Classpath里有指定的资源

@ConditionalOnWebApplication 这是一个Web应用程序

@ConditionalOnNotWebApplication 这不是一个Web应用程序

声明Bean的注解:

@Component : 组件,没有明确的角色

@Service : 在业务逻辑层(service层)使用

@Repository : 在数据访问层(dao层)使用.

@Controller : 在展现层(MVC--SpringMVC)使用

注入Bean的注解:

@Aautowired : Spring提供的注解.

@Inject : JSR-330提供的注解

@Resource : JSR-250提供的注解

@Primary 注入时优先使用此注解下的实现类，对应org.springframework.beans.factory.NoUniqueBeanDefinitionException异常

配置文件的注解:

@Configuration : 声明当前类是个配置类,相当于一个Spring配置的xml文件.

@ComponentScan (cn.test.demo): 自动扫描包名下所有使用 @Component @Service @Repository @Controller 的类,并注册为Bean

@WiselyConfiguration : 组合注解可以替代 @Configuration和@ComponentScan

@Bean : 注解在方法上,声明当前方法的返回值为一个Bean.

@Bean(initMethod="aa",destroyMethod="bb")--> 指定 aa和bb方法在构造之后.Bean销毁之前执行.

AOP切面编程注解:

@Aspect : 声明这是一个切面

@After @Before. @Around 定义切面,可以直接将拦截规则(切入点 PointCut)作为参数

@PointCut : 专门定义拦截规则然后在 @After @Before. @Around 中调用

@Transcational : 事务处理

@Cacheable : 数据缓存

@EnableAaspectJAutoProxy : 开启Spring 对这个切面(Aspect )的支持

@Target (ElementType.TYPE):元注解,用来指定注解修饰类的那个成员 -->指定拦截规则

@Retention(RetentionPolicy.RUNTIME)

--->当定义的注解的@Retention为RUNTIME时，才能够通过运行时的反射机制来处理注解.-->指定拦截规则

Spring 常用配置:

@import :导入配置类

@Scope : 新建Bean的实例 @Scope("prototype") 声明Scope 为 Prototype

@Value : 属性注入

@Value ("我爱你") --> 普通字符串注入

@Value ("#{systemProperties['os.name']}") -->注入操作系统属性

@Value ("#{ T (java.lang.Math).random() * 100.0 }") --> 注入表达式结果

@Value ("#{demoService.another}") --> 注入其他Bean属性

@Value ( "classpath:com/wisely/highlight_spring4/ch2/el/test.txt" ) --> 注入文件资源

@Value ("http://www.baidu.com")-->注入网址资源

@Value ("${book.name}" ) --> 注入配置文件注意: 使用的是$ 而不是 #

@PostConstruct : 在构造函数执行完之后执行

@PreDestroy : 在 Bean 销毁之前执行

@ActiveProfiles : 用来声明活动的 profile

@profile: 为不同环境下使用不同的配置提供了支持

@Profile("dev") .......对方法名为 dev-xxxx的方法提供实例化Bean

@EnableAsync : 开启异步任务的支持(多线程)

@Asyns : 声明这是一个异步任务,可以在类级别和方法级别声明.

@EnableScheduling : 开启对计划任务的支持(定时器)

@Scheduled : 声明这是一个计划任务支持多种计划任务,包含 cron. fixDelay fixRate

@Scheduled (dixedDelay = 5000) 通过注解定时更新

@Conditional : 条件注解,根据满足某一特定条件创建一个特定的Bean

@ContextConfiguration : 加载配置文件

@ContextConfiguration(classes = {TestConfig.class})

@ContextConfiguration用来加载ApplicationContext

classes属性用来加载配置类

@WebAppCofiguration : 指定加载 ApplicationContext是一个WebApplicationContext

@Enable注解:*

@EnableAsync : 开启异步任务的支持(多线程)

@EnableScheduling : 开启对计划任务的支持(定时器)

@EnableWebMVC : 开启对Web MVC 的配置支持

@EnableAaspectJAutoProxy : 开启Spring 对这个切面(Aspect )的支持

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

@EnableJpaRepositories : 开启对Spring Data JAP Repository 的支持

@EnableTransactionManagement 开启对注解式事物的支持

@EnableCaching开启注解是缓存的支持.

@EnableDiscoveryClient 让服务发现服务器,使用服务器.Spring cloud 实现服务发现

@EnableEurekaServer 注册服务器 spring cloud 实现服务注册@

@EnableScheduling 让spring可以进行任务调度,功能类似于spring.xml文件中的命名空间task:\*

@EnableCaching 开启Cache缓存支持;

SpringMVC 常用注解:

@Controller : 注解在类上声明这个类是springmvc里的Controller,将其声明为一个spring的Bean.

@RequestMapping :可以注解在类上和方法上映射WEB请求(访问路径和参数)

@RequestMapping(value= "/convert",produces+{"application/x-wisely"}) 设置访问URL 返回值类型

@ResponseBody : 支持将返回值放入response体内而不是返回一个页面(返回的是一个组数据)

@RequestBody : 允许request的参数在request体中,而不是直接连接在地址后面次注解放置在参数前

@Path Variable : 用来接收路径参数如/test/001,001为参数,次注解放置在参数前

@RestController : @Controller + @ResponseBody 组合注解

@ControllerAdvice : 通过@ControllerAdvice可以将对已控制器的全局配置放置在同一个位置

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

@ExceptionHandier(value=Exception.class) -->通过value属性可过滤拦截器条件,拦截所有的异常

@InitBinder : 用来设置WebDataBinder , WebDataBinder用来自动绑定前台请求参数到Model中.

@ModelAttrbuute : 绑定键值对到Model中,

@RunWith : 运行器

@RunWith(JUnit4.class)就是指用JUnit4来运行

@RunWith(SpringJUnit4ClassRunner.class),让测试运行于Spring测试环境

@RunWith(Suite.class)的话就是一套测试集合，

@WebAppConfiguration("src/main/resources") : 注解在类上,用来声明加载的ApplicationContex 是一个WebApplicationContext ,它的属性指定的是Web资源的位置,默认为 src/main/webapp ,自定义修改为 resource

@Before : 在 xxx 前初始化

Spring Boot 注解:

@SpringBootApplication : 是Spring Boot 项目的核心注解主要目的是开启自动配置

@SpringBootApplication注解是一个组合注解,主要组合了@Configuration .+@EnableAutoConfiguration.+@ComponentScan

@Value : 属性注入,读取properties或者 Yml 文件中的属性

@ConfigurationProperties : 将properties属性和一个Bean及其属性关联,从而实现类型安全的配置

@ConfigurationProperties(prefix = "author",locations = {"classpath:config/author.properties"})

通过@ConfigurationProperties加载配置,通过prefix属性指定配置前缀,通过location指定配置文件位置

@EnableAutoConfiguration 注解:作用在于让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置这个注解告诉Spring Boot根据添加的jar依赖猜测你想如何配置Spring。由于spring-boot-starter-web

添加了Tomcat和Spring MVC，所以auto-configuration将假定你正在开发一个web应用并相应地对Spring进行设置。

@ Configuration 注解，以明确指出该类是 Bean 配置的信息源

@ComponentScan 注解会告知Spring扫描指定的包来初始化Spring Bean这能够确保我们声明的Bean能够被发现。

@ImportResource 注解加载XML配置文件

@EnableAutoConfiguration (exclude={xxxx.class}) 禁用特定的自动配置

@SpringBootApplication 注解等价于以默认属性使用 @Configuration，@EnableAutoConfiguration和 @ComponentScan。

@SuppressWarnings注解

@SuppressWarnings("unchecked")

告诉编译器忽略 unchecked 警告信息,如使用 list ArrayList等未进行参数化产生的警告信息

@SuppressWarnings("serial")

如果编译器出现这样的警告信息: The serializable class WmailCalendar does not declare a static final serialVersionUID field of type long 使用这个注释将警告信息去掉。

@SuppressWarnings("deprecation")

如果使用了使用@Deprecated注释的方法，编译器将出现警告信息。使用这个注释将警告信息去掉。

@SuppressWarnings("unchecked", "deprecation")

告诉编译器同时忽略unchecked和deprecation的警告信息。

@SuppressWarnings(value={"unchecked", "deprecation"})

等同于@SuppressWarnings("unchecked", "deprecation")

案例

@Entity

@Table(name = "S_PRODUCEINFO" )

@Data

@NoArgsConstructor

@AllArgsConstructor

public class ProduceInfoEntity {

@Id
@Column(name = "app_name", unique = **true**, length = 50) **private** String name; @Column(name = "status") @Enumerated(EnumType. ***STRING***) **private** ProduceStatus status; @Column(name = "create_time", updatable = **false**) @Temporal(TemporalType. ***TIMESTAMP***) @CreationTimestamp **private** Date createTime; @Column(name = "update_time") @Temporal(TemporalType. ***TIMESTAMP***) @UpdateTimestamp **private** Date updateTime;

@Entity : 映射数据库实体类

@Table(name = "S_PRODUCEINFO" ) : 表名为 "S_PRODUCEINFO"

@Id : 声明主键ID

@Column(name = "app_name", unique = true, length = 50) :对应数据库字段,属性

@Enumerated(EnumType. STRING) : 采用枚举值类型和数据库字段进行交互

@Temporal : 时间格式映射数据库会得到规定时间格式的日期

@Enumerted(EnumType.STRING) HH:MM:SS 格式的日期

@Enumerted(EnumType.DATE) 获取年月日 yyyy-MM-dd

@Enumerted(EnumType.TIME) 获取时分秒 HH:MM:SS

-------Mr.Ge提供以上资源

本文内容总结：Spring 各种注解备注，

原文链接：https://www.cnblogs.com/think90/p/8445396.html