SpringBoot框架(2):开发使用的注解

使用注解的优势:

 1.采用纯java代码,不在需要配置繁杂的xml文件
 2.在配置中也可享受面向对象带来的好处
 3.类型安全对重构可以提供良好的支持
 4.减少复杂配置文件的同时亦能享受到springIoC容器提供的功能

注解本身没有功能的,就和 xml 一样。注解和 xml 都是一种元数据,元数据即解释数据的数据,这就是所谓配置。

Spring部分

1、声明bean的注解

  • @Component :泛指组件,没有明确的角色,当组件不好归类的时候,我们可以使用这个注解进行标注。
  • @Service :在业务逻辑层使用,一般用于修饰service层的组件
  • @Repository 在数据访问层使用,使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供XML配置项。
  • @Controller :在展现层使用,控制器的声明,用于定义控制器类,在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层),一般这个注解在类中,通常方法需要配合注解@RequestMapping。

2、注入bean的注解

  • @Autowired:由Spring提供
    自动导入依赖的bean。byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错。
  • @Inject:由JSR-330提供
    等价于默认的@Autowired,只是没有required属性;
  • @Resource(name=”name”,type=”type”):由JSR-250提供
    都可以注解在set方法和属性上,推荐注解在属性上(一目了然,少写代码)。没有括号内内容的话,默认byName。与@Autowired干类似的事。
  • @Qualifier:当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,但能进行更细粒度的控制如何选择候选者。

3、java配置类相关注解

  • @Configuration: 声明当前类为配置类,相当于传统的xml配置文件,作用于Spring配置(类上),其中内部组合了@Component注解,表明这个类是一个bean(类上)

  • @Bean : 注解在方法上,而不是类,声明当前方法的返回值为一个bean,替代xml中的方式(方法上),用@Bean标注方法等价于XML中配置的bean。意思是产生一个bean,并交给spring管理。

  • @ComponentScan :表示将该类自动发现扫描组件。使用@ComponentScan注解搜索Spring组件,包括@Configuration、@Component、@Controller、@Service,并注册为Bean。我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。如果没有配置的话,SpringBoot会扫描启动类所在包下以及子包下的使用了@Service,@Repository等注解的类。

  • @WishlyConfiguration : 为@Configuration与@ComponentScan的组合注解,可以替代这两个注解

4、切面(AOP)相关注解

Spring支持AspectJ的注解式切面编程。

  • @Aspect: 声明一个切面(类上)
    使用@After、@Before、@Around定义建言(advice),可直接将拦截规则(切点)作为参数。
  • @After : 在方法执行之后执行(方法上)
  • @Before : 在方法执行之前执行(方法上)
  • @Around : 在方法执行之前与之后执行(方法上)
  • @PointCut : 声明切点
    在java配置类中使用@EnableAspectJAutoProxy注解开启Spring对AspectJ代理的支持(类上)

springIOC注解

  • @Import:通过导入的方式实现把实例加入springIOC容器中
  • @ImportResource:用来加载xml配置文件。

5、@Bean的属性支持

  • @Scope 设置Spring容器如何新建Bean实例(方法上,得有@Bean)
其设置类型包括:

1.Singleton :(单例,一个Spring容器中只有一个bean实例,默认模式),
2.Protetype (每次调用新建一个bean),
3.Request (web项目中,给每个http request新建一个bean),
4.Session (web项目中,给每个http session新建一个bean),

  1. GlobalSession(给每一个 global http session新建一个Bean实例)
  • @StepScope: 在Spring Batch中还有涉及
  • @PostConstruct : 由JSR-250提供,在构造函数执行完之后执行,等价于xml配置文件中bean的initMethod
  • @PreDestory : 由JSR-250提供,在Bean销毁之前执行,等价于xml配置文件中bean的destroyMethod

6、@Value注解

  • @Value :注入Spring boot application.properties配置的属性的值。为属性注入值(属性上),支持如下方式的注入:示例代码:
    注入配置文件
@Value("${server.port}")
private String port;

注入配置使用方法:
① 编写配置文件(test.properties)
book.name=《三体》
② @PropertySource 加载配置文件(类上)

@PropertySource("classpath:com/fjq/test/test.properties")

③ 还需配置一个PropertySourcesPlaceholderConfigurer的bean。

7、环境切换

  • @Profile:通过设定Environment的ActiveProfiles来设定当前context需要使用的配置环境。(类或方法上)
  • @Conditional:Spring4中可以使用此注解定义条件话的bean,通过实现Condition接口,并重写matches方法,从而决定该bean是否被实例化。(方法上)

8、异步相关

  • @EnableAsync :配置类中,通过此注解开启对异步任务的支持,叙事性AsyncConfigurer接口(类上)
  • @Async :在实际执行的bean方法使用该注解来申明其是一个异步任务(方法上或类上所有的方法都将异步,需要@EnableAsync开启异步任务)

9、定时任务相关

  • @EnableScheduling:在配置类上使用,开启计划任务的支持(类上)
  • @Scheduled:来申明这是一个任务,包括cron,fixDelay,fixRate等类型(方法上,需先开启计划任务的支持)

10、@Enable*注解说明

这些注解主要用来开启对xxx的支持。

  • @EnableAspectJAutoProxy :开启对AspectJ自动代理的支持
  • @EnableAsync :开启异步方法的支持
  • @EnableScheduling :开启计划任务的支持
  • @EnableWebMvc :开启Web MVC的配置支持
  • @EnableConfigurationProperties :开启对@ConfigurationProperties注解配置Bean的支持
  • @EnableJpaRepositories :开启对SpringData JPA Repository的支持
  • @EnableTransactionManagement :开启注解式事务的支持
  • @EnableTransactionManagement :开启注解式事务的支持
  • @EnableCaching:开启注解式的缓存支持

11、测试相关注解

  • @RunWith:运行器,Spring中通常用于对JUnit的支持
@RunWith(SpringJUnit4ClassRunner.class)
  • @ContextConfiguration:用来加载配置ApplicationContext,其中classes属性用来加载配置类
@ContextConfiguration(classes={TestConfig.class})

SpringMVC部分

  • @EnableWebMvc: 在配置类中开启Web MVC的配置支持,如一些ViewResolver或者MessageConverter等,若无此句,重写WebMvcConfigurerAdapter方法(用于对SpringMVC的配置)。

  • @Controller: 声明该类为SpringMVC中的Controller

  • @RequestMapping: 提供路由信息,负责URL映射到Controller中Web请求,包括访问路径和参数(类或方法上)

  • @ResponseBody: 支持将返回值放在response内,表示该方法的返回结果直接写入HTTP response body中,一般在异步获取数据时使用,用于构建RESTful的api。加上@responsebody后返回结果不会被解析为跳转路径(返回值位置或方法上),而是直接写入HTTP response body中。会直接返回json数据,该注解一般会配合@RequestMapping一起使用。

  • @RequestBody :允许request的参数在request体中,而不是在直接连接在地址后面。(放在参数前)

  • @PathVariable : 用于接收路径参数,比如@RequestMapping(“/hello/{name}”)申明的路径,将注解放在参数中前,即可获取该值,通常作为Restful的接口实现方法。

  • @RestController : 该注解为一个组合注解,用于标注控制层组件,相当于@Controller和@ResponseBody的组合,注解在类上,意味着,该Controller的所有方法都默认加上了@ResponseBody。

  • @ControllerAdvice : 通过该注解,我们可以将对于控制器的全局配置放置在同一个位置,注解了@Controller的类的方法可使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上,
    这对所有注解了 @RequestMapping的控制器内的方法有效。

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

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

  • @ModelAttribute: 本来的作用是绑定键值对到Model里,在@ControllerAdvice中是让全局的@RequestMapping都能获得在此处设置的键值对。

SpringBoot注解

  • @SpringBootApplication:申明让spring boot自动给程序进行必要的配置,这个配置等同于:@Configuration ,@EnableAutoConfiguration 和 @ComponentScan 三个配置。

  • @EnableAutoConfiguration:SpringBoot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的Spring应用。例如,如果你的classpath下存在HSQLDB,并且你没有手动配置任何数据库连接beans,那么我们将自动配置一个内存型(in-memory)数据库”。你可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类,你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容