Spring 注解
声明Bean的注解
给容器中注册组件;
1)、组件标注注解(@Controller/@Service/@Repository/@Component)[自己写的类]
@Component : 组件,没有明确的角色
@Service : 在业务逻辑层(service层)使用
@Repository : 在数据访问层(dao层)使用.
@Controller : 在展现层(MVC--SpringMVC)使用
2)、@Bean[导入的第三方包里面的组件],默认是单实例的
3)、@Import[快速给容器中导入一个组件],id默认是组件的全类名
1)、@Import(要导入到容器中的组件);容器中就会自动注册这个组件,id默认是全类名
2)、ImportSelector:返回需要导入的组件的全类名数组;
3)、ImportBeanDefinitionRegistrar:手动注册bean到容器中
4)、使用Spring提供的 FactoryBean(工厂Bean);
1)、默认获取到的是工厂bean调用getObject创建的对象
2)、要获取工厂Bean本身,我们需要给id前面加一个&
&colorFactoryBean
5)、包扫描
@ComponentScan value:指定要扫描的包
@ComponentScan (cn.test.demo): 自动扫描包名下所有使用 @Component @Service @Repository @Controller 的类,并注册为Bean。
默认会从声明@ComponentScan所在类的package进行扫描。该注解对应的xml形式是<context:component-scan >
excludeFilters = Filter[] :指定扫描的时候按照什么规则排除那些组件
includeFilters = Filter[] :指定扫描的时候只需要包含哪些组件
FilterType.ANNOTATION:按照注解
FilterType.ASSIGNABLE_TYPE:按照给定的类型;
FilterType.ASPECTJ:使用ASPECTJ表达式
FilterType.REGEX:使用正则指定
FilterType.CUSTOM:使用自定义规则
@ComponentScans(
value = {
@ComponentScan(value="com.atguigu",includeFilters = {
@Filter(type=FilterType.ANNOTATION,classes={Controller.class}),
@Filter(type=FilterType.ASSIGNABLE_TYPE,classes={BookService.class}),
@Filter(type=FilterType.CUSTOM,classes={MyTypeFilter.class})
},useDefaultFilters = false)
}
)
/**
* ConfigurableBeanFactory#SCOPE_PROTOTYPE
* @see ConfigurableBeanFactory#SCOPE_SINGLETON
* @see org.springframework.web.context.WebApplicationContext#SCOPE_REQUEST request
* @see org.springframework.web.context.WebApplicationContext#SCOPE_SESSION sesssion
* @return\
* @Scope:调整作用域
* prototype:多实例的:ioc容器启动并不会去调用方法创建对象放在容器中。
* 每次获取的时候才会调用方法创建对象;
* singleton:单实例的(默认值):ioc容器启动会调用方法创建对象放到ioc容器中。
* 以后每次获取就是直接从容器(map.get())中拿,
* request:同一次请求创建一个实例
* session:同一个session创建一个实例
*
* @Lazy懒加载:
* 单实例bean:默认在容器启动的时候创建对象;
* 懒加载:容器启动不创建对象。第一次使用(获取)Bean创建对象,并初始化;
*/
//类中组件统一设置。满足当前条件,这个类中配置的所有bean注册才能生效;
@Conditional({Condition}) : 按照一定的条件进行判断,满足条件给容器中注册bean
@Conditional({WindowsCondition.class})
指定Bean初始化和销毁的方法
/** * bean的生命周期: * bean创建---初始化----销毁的过程 * 容器管理bean的生命周期; * 我们可以自定义初始化和销毁方法;容器在bean进行到当前生命周期的时候来调用我们自定义的初始化和销毁方法 * * 构造(对象创建) * 单实例:在容器启动的时候创建对象 * 多实例:在每次获取的时候创建对象 * * 初始化: * 对象创建完成,并赋值好,调用初始化方法。。。 * 销毁: * 单实例:容器关闭的时候 * 多实例:容器不会管理这个bean;容器不会调用销毁方法; * * 1)、指定初始化和销毁方法; * 通过@Bean指定init-method和destroy-method; * 2)、通过让Bean实现InitializingBean(定义初始化逻辑), * DisposableBean(定义销毁逻辑); * 3)、可以使用JSR250; * @PostConstruct:在bean创建完成并且属性赋值完成[在构造函数执行完之后执行];来执行初始化方法 * @PreDestroy:在容器销毁bean之前通知我们进行清理工作 * 4)、BeanPostProcessor【interface】:bean的后置处理器; * 在bean初始化前后进行一些处理工作; * postProcessBeforeInitialization:在初始化之前工作 * postProcessAfterInitialization:在初始化之后工作 * * Spring底层对 BeanPostProcessor 的使用; * bean赋值,注入其他组件,@Autowired,生命周期注解功能,@Async,xxx BeanPostProcessor; * * */
注入Bean的注解
自动装配;
Spring利用依赖注入(DI),完成对IOC容器中中各个组件的依赖关系赋值;
1)、@Autowired:自动注入:[Spring的注解]
1)、默认优先按照类型去容器中找对应的组件:applicationContext.getBean(BookDao.class);找到就赋值
2)、如果找到多个相同类型的组件,再将属性的名称作为组件的id去容器中查找
applicationContext.getBean("bookDao")
3)、@Qualifier("bookDao2"):使用@Qualifier指定需要装配的组件的id,而不是使用属性名
4)、自动装配默认一定要将属性赋值好,没有就会报错;
可以使用@Autowired(required=false);
5)、@Primary:标识为首选的,让Spring进行自动装配的时候,默认使用首选的bean;
也可以继续使用@Qualifier指定需要装配的bean的名字
2)、Spring还支持使用@Resource(JSR250)和@Inject(JSR330)[java规范的注解]
@Resource:
可以和@Autowired一样实现自动装配功能;默认是按照组件名称进行装配的;
没有能支持@Primary功能没有支持@Autowired(reqiured=false);
@Inject:
需要导入javax.inject的包,和Autowired的功能一样。没有required=false的功能;
@Autowired:Spring定义的; @Resource、@Inject都是java规范
这三个都是通过AutowiredAnnotationBeanPostProcessor:解析完成自动装配功能;
3)、 @Autowired:构造器,参数,方法,属性;都是从容器中获取参数组件的值
1)、[标注在方法位置]:@Bean+方法参数;参数从容器中获取;默认不写@Autowired效果是一样的;都能自动装配
2)、[标在构造器上]:如果组件只有一个有参构造器,这个有参构造器的@Autowired可以省略,参数位置的组件还是可以自动从容器中获取
3)、放在参数位置:
4)、自定义组件想要使用Spring容器底层的一些组件(ApplicationContext,BeanFactory,xxx);
自定义组件实现xxxAware;在创建对象的时候,会调用接口规定的方法注入相关组件;Aware;
把Spring底层一些组件注入到自定义的Bean中;
xxxAware:功能使用xxxProcessor;
ApplicationContextAware==》ApplicationContextAwareProcessor;
配置文件的注解
@Configuration : 声明当前类是个配置类,相当于一个Spring配置的xml文件.
@PropertySource:加载外部资源文件
@WiselyConfiguration : 组合注解 可以替代 @Configuration和@ComponentScan
//@ConfigurationProperties
//要求JDK >= 1.8 @Configuration @PropertySource("classpath:1.properties") @PropertySource("classpath:2.properties") public class XConfiguration { } //JDK小于1.8则需要借助@PropertySources @Configuration @PropertySources({ @PropertySource("classpath:1.properties"), @PropertySource("classpath:2.properties"), @PropertySource("classpath:3.properties") }) public class XConfiguration { } @Configuration @Import(StoreOrder.class)//引入JavaConfig形式定义的Bean配置 @ImportResource("classpath:order.xml")//引入xml形式定义的Bean配置 public class XConfiguration { }
AOP切面编程注解
@Aspect : 声明这是一个切面
@After @Before. @Around 定义切面,可以直接将拦截规则(切入点 PointCut)作为参数
@PointCut : 专门定义拦截规则 然后在 @After @Before. @Around 中调用
@Transcational : 事务处理
@Cacheable : 数据缓存
@EnableAaspectJAutoProxy : 开启Spring 对 这个切面(Aspect )的支持
@Target (ElementType.TYPE):元注解,用来指定注解修饰类的那个成员 -->指定拦截规则
@Retention(RetentionPolicy.RUNTIME):当定义的注解的@Retention为RUNTIME时,才能够通过运行时的反射机制来处理注解.,指定拦截规则
属性赋值@Value
@Value : 属性注入,可以支持两种表达式来加载属性值 一种是PlaceHolder方式,格式为${...},一种是SpEL(Spring Expression Language),格式为#{...} @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}" ) --> 注入配置文件 注意: 使用的是$ 而不是 #
@Profile切换环境
@ActiveProfiles : 用来声明活动的 profile
@Profile: 为不同环境下使用不同的配置提供了支持,动态的激活和切换一系列组件的功能
@Profile("dev") .......对方法名为 dev-xxxx的方法提供实例化Bean
@Profile:指定组件在哪个环境的情况下才能被注册到容器中,不指定,任何环境下都能注册这个组件 1)、加了环境标识的bean,只有这个环境被激活的时候才能注册到容器中。默认是default环境 2)、写在配置类上,只有是指定的环境的时候,整个配置类里面的所有配置才能开始生效 3)、没有标注环境标识的bean在,任何环境下都是加载的;
Spring 常用配置
@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 @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.TIMESTAMP) 日期格式 @Enumerted(EnumType.DATE) 获取年月日 yyyy-MM-dd @Enumerted(EnumType.TIME) 获取时分秒 HH:MM:SS */