您现在的位置是:首页 > 个人博客日记 个人博客日记

java Spring注解总结

2019-09-09 15:26:35

逐渐的,在Spring的开发过程中,注解的使用越来越频繁,之前一直不喜欢注解,因为个人觉得可读性不好,但是正是这个原因使得自己不愿意花时间在这个上面花费时间研究,大势所趋,要学的是逃不掉的,于是就整理了一番,见到的都整理到这里,和其他文章一样,这篇文章不会一蹴而就,而是会逐渐更新,有新的就会更新到这里

一、注解总览

1.Spring注解

  1. @Configuration
  2. @Bean
  3. @Scope
  4. @Lazy
  5. @Conditional
  6. @ComponentScan
  7. @Import
  8. @Value
  9. @PropertySource
  10. @ConfigurationProperties
  11. @AutoWired
  12. @Profile
  13. AOP相关
  14. @Before
  15. @After
  16. @AfterReturning
  17. @AfterThrowing
  18. @Around
  19. @Pointcut
  20. @Aspect
  21. @EnableAspectJAutoProxy
  22. 声明式事务
  23. @Transactional
  24. @EnableTransactionManagement

2.SpringMVC注解

  1. 常见注解
  2. @Controller
  3. @ResponseBody
  4. @RestController
  5. @ModelAttribute
  6. @SessionAttributes
  7. @requestParam
  8. @RequestHeader
  9. @CookieValue
  10. @PathVariable
  11. @Component
  12. @Repository
  13. SpringMVC的整合
  14. 其他的配置

3.原生JavaWeb注解

二、注解解释

1.Spring注解

  1. @Configuration
  2. 被该注解标注的类对应于之前配置开发的applicationContext.xml
  3. @Bean
  4. 被该注解标注的方法相当于之前在applicationContext.xml中的一个<bean ... />配置;
  5. 返回值类型就是<bean ... />中的class属性的值,方法名就是<bean ... />中的id属性的值;
  6. 参数中可以指定initMethoddestroyMethod方法
  7. 还有一种方式,就是我们的bean实现两个接口:InitializingBeanDisposableBean即可(记得给Bean添加@Component);
  8. @PostConstruct@PreDestroy:这两个配置在Bean的初始化和销毁的方法上(记得给Bean添加@Component);
  9. 接口:BeanPostProcessor,初始化前后调用定义的两个方法(记得给Bean添加@Component);
  10. 对应的Bean方法也可以添加参数,但是这个参数必须能在Spring容器中唯一定位;
  11. @Scope
  12. 作用在配置类的方法上,用来提到<bean ... />的scope属性;
  13. @Lazy
  14. 作用在配置类的方法上,用来使得单例的对象也延迟加载;
  15. @Conditional
  16. 有条件的把标注的方法返回的对象注入到Spring容器中;需要自定义一个实现了SpringCondition接口的类,添加到注解的参数即可;
  17. @ComponentScan
  18. 该注解主要标注在配置类上,相当于applicationContext.xml中的<context:conponent-scan ··· />;
  19. @Import
  20. 原生类导入
  21. 直接把一些类放在@Import的参数中,就可以把这个类导入到Spring的容器中;
  22. ImportSelector
  23. 用来给打@Import的类批量的,有选择的导入一些类到Spring的容器中;@Import参数是实现了ImportSelector接口的类,返回的是要注入的类的全类名字符串;
  24. ImportBeanDefinitionRegistrar
  25. 手动注册类,@Import参数是实现了ImportBeanDefinitionRegistrar接口的类,没有返回值;
  26. @Value
  27. 用来给Bean的字段赋值
  28. 参数为字面量
  29. 参数为SpEL,用来计算:#{}
  30. 参数为${},用来获取配置文件的值,配合@PropertySource使用;
  31. @PropertySource
  32. 用来加载配置文件,标注在配置类上;
  33. @ConfigurationProperties
  34. 用来把application.properties/yml配置文件中的属性注入到Bean中,所以一般添加在配置类的方法上,当然也可以添加在类上;
  35. 当这个注解 @ConfigurationProperties 放在类上的时候,那么这个类就是一个实体类,一般配合@Component 来使用,即把这个类实例化一份,并把配置文件中对应 prefix 转配到这个实体中,然后把这个实体放入Spring容器中;
  36. 如果注解 @ConfigurationProperties 放在方法上,即把配置文件的值装配到该方法的返回的 Bean 中,这种情况一般是是在配置类的情况下,一般配合方法的 @Bean 注解结合使用;当然了,在这种情况下,返回的 Bean 对应的类上就不需要 @Component @ConfigurationProperties来修饰了,这里需要注意一下;
  37. @ConfigurationProperties(prefix="<key-prefix-in-properties/yml>")
  38. @AutoWired
  39. 自动把容器中的对象装载进打了该标签的变量;先按照类型找,在按照变量名称找,如果要指定要装配的组件,配合使用@Qualifier指定组件的id即可,也可以使用@Primary首选项来指定(配置在配置类的方法上);
  40. 可以添加参数required来表明当在容器中找不到这个对象时怎么处理;
  41. 这个功能还可以通过Java标准的注解:@Resource(默认按照字段名称装配的)和@Inject(需要导入jar,除了required外和AutoWired一样)来实现;
  42. 可以标注在字段上,字段的setter方法上,构造方法上;当标注在构造方法上,如果构造方法的参数在容器中有,那么就自动从容器中获取;
  43. @Profile
  44. 老的项目中一般解决项目的多套配置一般都是使用MavenProfile配置来解决,而MavenProfile是基于配置文件的,在使用了全注解的情况下,SpringProfile就登场了;
  45. 用法这里简单说一下,我把这里的Profile分为两种,一种就是不同的环境使用不同的Bean,如数据源的不同,另外一种就是使用不同参数配置,如端口;当然你也可以把前者使用后者实现:
  46. 1.对于使用不同的Bean,可以这样做:假如创建三种配置的数据源,当然这些数据源都在一个配置类中,每个@Bean配置一个数据源,在每个@Bean的方法上添加@Profile,参数就是这个Profile的名字,类似于MavenProfiledev/beta/online,注意的是,添加了@Profile之后,只有是 defaultBean才会被注入注册到容器中,而且加了环境标识的Bean只有这个环境被激活的时候才会被注册到容器中;问题是如何切换环境的激活状态:
  47. 运行参数:(通用的方式)
  48. Java虚拟机参数:-Dspring.profiles.active=<active-profile-name>
  49. Program arguments(java -jar运行的时候):--spring.profiles.active=<active-profile-name>
  50. 代码的方式实现,如下:
  51. //1、获取applicationContext
  52. AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
  53. //2、设置激活的环境
  54. ctx.getEnvironment().setActiveProfiles("development");
  55. //3、注册配置类
  56. ctx.register(<come-config-class>.class);
  57. //4、刷新容器
  58. ctx.refresh();
  59. 仔细想想,这个功能之前的一个注解@Conditional能不能实现呢?☺
  60. 2.对于不同的配置参数,可以创建不同的配置文件,如:application-<env-name>.properties/yml
  61. 在配置文件中使用spring.profiles.active=<env-name>来指定当前使用的环境配置;
  62. 而且使用yml文件的话,还可以在一个配置文件中利用yml的文档块来配置多个环境,三个英文的-就把文档分为两个文档块,具体摆渡一下就知道了,如:
  63. server:
  64. port: 8081
  65. spring:
  66. profiles:
  67. active: prod # 要使用的环境名称
  68. ---
  69. server:
  70. port: 8082
  71. spring:
  72. profiles: dev
  73. ---
  74. server:
  75. port: 8083
  76. spring:
  77. profiles: prod
  78. AOP相关,参数就是AspectJ表达式,每个方法都可以添加一个参数:JoinPoint(必须作为第一个参数)来查看目标方法的信息,如方法名,参数等:
  79. @Before
  80. @After:正常异常完成后调用
  81. @AfterReturning:目标方法正常返回,在这个方法上可以添加参数来接收目标方法的返回值,并且在这个注解的参数中使用returning指定这个参数的名称;
  82. @AfterThrowing:异常繁盛就会调用这个方法,同样可以使用throwing来接收目标方法的异常对象信息;
  83. @Around
  84. @Pointcut:用来指定公共的切入点表达式,上面的注解的参数就像调用方法一样调用这个注解标注的方法,每个上面也可以有自己的切入点表达式;
  85. @Aspect:表明标注的类是一个切面类,这个切面类里面的方法标注上面的注解;
  86. @EnableAspectJAutoProxy:相当于在配置文件中的开启基于注解的配置文件<aop:aspectj-autoprocy />
  87. 声明式事务:
  88. @TransactionalService的实现方法上添加
  89. @EnableTransactionManagement:相当于在配置文件中开启配置式的事务<tx:annotation-driven />;
  90. 向容器中注入一个DataSourceTransactionManager

2.SpringMVC注解,参考

  1. 常见注解
  2. @Controller
  3. @ResponseBody
  4. @RestController
  5. @ModelAttribute
  6. @SessionAttributes
  7. @requestParam
  8. @RequestHeader
  9. @CookieValue
  10. @PathVariable
  11. @Component
  12. @Repository
  13. SpringMVC的整合
  14. 编写一个继承于AbstractAnnotationConfigDispatcherServletInitializer的初始化器,重写三个方法:
  15. getRootConfigClasses:用于返回包含Spring的配置类的数组,形成Spring的一个父容器;
  16. getServletConfigClasses:用于返回包含SpringMVC配置类的数组,形成Spring的一个子容器;
  17. getServletMappings:用于返回包含Spring的拦截请求信息的数组,类似于web.xml中配置的url-pattern中的内容;
  18. 创建两个配置类:ApplicationContextConfig.javaSpringMVCConfig.java
  19. Spring配置类:添加注解@ComponentScan
  20. @ComponentScan(value = "org.shreker.web", excludeFilters = {
  21. @Filter(type = FilterType.ANNOTATION, classes={Controller.class})
  22. })
  23. SpringMVC配置类:添加注解@ComponentScan,注意:在include的时候一定要禁用默认的过滤规则,否则无效
  24. @ComponentScan(value = "org.shreker.web", includeFilters = {
  25. @Filter(type = FilterType.ANNOTATION, classes = {Controller.class})
  26. }, useDefaultFilters = false)
  27. 其他的配置,参考官网文档
  28. SpringMVC的配置类上添加注解:@EnableWebMvc,即开启SpringMVC的其他配置,类比于配置文件中的<mvc:annotation-driven />;
  29. SpringMVC的配置类继承WebMvcConfigurerAdapter(当然你也可以实现接口WebMvcConfigurer);在这些方法中,有各种配置的方法,根据需要实现即可,实现也特比诶简单,只需要研究传递进来的参数即可;

3.原生JavaWeb注解

  1. @WebServlet
  2. @WebFilter
  3. @WebInitParam
  4. @WebListener
  5. @MultipartConfig

以上的注解都是servlet 3.0(不需要web.xml)模块的,其他的请移步到jcp网站了解(右上角搜索servlet 3.0,就会导航到标准的下载页面 下载查看即可)



关注TinyMeng博客,更多精彩分享,敬请期待!
 

站点信息