spring 常用注解汇总

jar包:common-annotations.jar
命名空间:引入context 的 Schema命名空间 在配置文件中添加context:annotation-config标签
配置扫描注解:<context:component-scan/>
扫描过滤方式

过滤器类型说明
注释假如 com.baobaotao.SomeAnnotation 是一个注释类,我们可以将使用该注释的类过滤出来。
类名指定通过全限定类名进行过滤,如您可以指定将 com.baobaotao.Boss 纳入扫描,而将 com.baobaotao.Car 排除在外。
正则表达式通过正则表达式定义过滤的类,如下所示: com\.baobaotao\.Default.*
AspectJ 表达式通过 AspectJ 表达式定义过滤的类,如下所示: com. baobaotao..*Service+

值得注意的是 <context:component-scan/> 配置项不但启用了对类包进行扫描以实施注释驱动 Bean 定义的功能,同时还启用了注释驱动自动注入的功能(即还隐式地在内部注册了AutowiredAnnotationBeanPostProcessor 和 CommonAnnotationBeanPostProcessor),因此当使用 <context:component-scan/> 后,就可以将 <context:annotation-config/> 移除了。


<context:component-scan base-package="controller.*" />  <context:component-scan base-package="controller.**" />  **匹配任意class文件和包,而*只能匹配包,因此无法扫描到包下的类,因此也就无法被Spring管理。


声明bean的注解

@Controller用于标注控制层组件(如struts中的action) 默认的bean名字为这个类的类名首字母小写
@Service用于标注业务层组件,
@Repository用于标注数据访问组件,即DAO组件,
@Component一个标准普通的spring Bean类,泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。主要用于工具类 不推荐

@RestController
Spring4之后加入的注解,原来在@Controller中返回json需要@ResponseBody来配合,如果直接用@RestController替代@Controller就不需要再配置@ResponseBody,默认返回json格式。

@RestController注解下返回到jsp视图页面

@RequestMapping(value="/tologin", method=RequestMethod.GET)
    public ModelAndView login(){
        ModelAndView mv = new ModelAndView("index");
        return mv;
    }
注入bean的注解

@Autowired(Spring提供) 默认按类型装配,如果我们想使用按名称装配,可以结合@Qualifier注解一起使用
@Resource(JSR-250提供) 默认按名称装配,当找不到与名称匹配的bean才会按类型装配。
@Inject(JSR-330提供) 根据类型进行自动装配的,如果需要按名称进行装配,则需要配合 @Named
都可以注解在set方法和属性上,推荐注解在属性上(一目了然,少写代码)

java配置类相关注解

@Configuration 声明当前类为配置类,相当于xml形式的Spring配置(类上)
@Bean 注解在方法上,声明当前方法的返回值为一个bean,替代xml中的方式(方法上)
@Configuration 声明当前类为配置类,其中内部组合了@Component注解,表明这个类是一个bean(类上)
@ComponentScan 用于对Component进行扫描,相当于xml中的(类上)
@WishlyConfiguration 为@Configuration与@ComponentScan的组合注解,可以替代这两个注解

切面(AOP)相关注解

Spring支持AspectJ的注解式切面编程。
@Aspect 声明一个切面(类上) 
使用@After、@Before、@Around定义建言(advice),可直接将拦截规则(切点)作为参数。

@After 在方法执行之后执行(方法上) 
@Before 在方法执行之前执行(方法上) 
@Around 在方法执行之前与之后执行(方法上)

@PointCut 声明切点 
在java配置类中使用@EnableAspectJAutoProxy注解开启Spring对AspectJ代理的支持(类上)

@Bean的属性支持
  • @Scope用于指定scope作用域的(用在类上)
    其设置类型包括:
    • singleton (单例,一个Spring容器中只有一个bean实例, 默认模式

    • protetype (每次调用新建一个bean), 多实例模式 每次获取Bean的时候会有一个新的实例

    • request (web项目中,给每个http request新建一个bean), 

    • session (web项目中,给每个http session新建一个bean), 表示在每一个session中只有一个该对象

    • globalSession(给每一个 global http session新建一个Bean实例)

    • 注解格式:@scope("prototype")

    • xml格式

<bean id="role" class="spring.chapter2.maryGame.Role" scope="singleton"/>
或者
<bean id="role" class="spring.chapter2.maryGame.Role" singleton="true"/>

@PostConstruct 由JSR-250提供,在构造函数执行完之后执行,等价于xml配置文件中bean的initMethod
@PreDestory 由JSR-250提供,在Bean销毁之前执行,等价于xml配置文件中bean的destroyMethod
@Lazy(true) 表示延迟初始化

@Value注解

@Value 为属性注入值(属性上)
注入普通字符:@Value("Michael Jackson")String name;
注入操作系统属性:@Value("#{systemProperties['os.name']}")String osName;
注入表达式结果:@Value("#{ T(java.lang.Math).random() * 100 }") String randomNumber;
注入其它bean属性:@Value("#{domeClass.name}")String name;
注入文件资源:@Value("classpath:com/hgs/hello/test.txt")String Resource file;
注入网站资源:@Value("http://www.cznovel.com")Resource url;
注入配置文件:Value("${book.name}")String bookName;

注入配置使用方法:

① 编写配置文件(test.properties): book.name=《三体》
② @PropertySource 加载配置文件(类上)
@PropertySource("classpath:com/hgs/hello/test/test.propertie")
③ 还需配置一个PropertySourcesPlaceholderConfigurer的bean

环境切换

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

异步相关

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

定时任务相关

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

@Enable*注解说明

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

测试相关注解

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

事务管理

@Transactional( rollbackFor={Exception.class}) 事务管理

SpringMVC部分

@EnableWebMvc 在配置类中开启Web MVC的配置支持,如一些ViewResolver或者MessageConverter等,若无此句,重写WebMvcConfigurerAdapter方法(用于对SpringMVC的配置)。
@Controller 声明该类为SpringMVC中的Controller
@RequestMapping 用于映射Web请求,包括访问路径和参数(类或方法上)
@ResponseBody 支持将返回值放在response内,而不是一个页面,通常用户返回json数据(返回值旁或方法上)
@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都能获得在此处设置的键值对。
主要有两种使用方式,一种是标注在方法上,一种是标注在 Controller 方法参数上。
@CookieValue 绑定了cookie 的值到方法参数上
@SessionAttributes 传递和保存数据
@RequestHeader 注解绑定 HttpServletRequest 头信息到 Controller 方法参数


@RequestParam 用于将请求参数区数据映射到功能处理方法的参数上

public Resp test(@RequestParam Integer id){
        return Resp.success(customerInfoService.fetch(id));
}

这个id就是要接收从接口传递过来的参数id的值的,如果接口传递过来的参数名和你接收的不一致,也可以如下

public Resp test(@RequestParam(value="course_id") Integer id){
        return Resp.success(customerInfoService.fetch(id));
}

其中course_id就是接口传递的参数,id就是映射course_id的参数名


Spring 4.2新特性-使用@Order调整配置类加载顺序

lombok 简化java代码注解  @Data   :注解在类上;提供类所有属性的 getting 和 setting 方法,此外还提供了equals、canEqual、hashCode、toString 方法
@Setter:注解在属性上;为属性提供 setting 方法
@Getter:注解在属性上;为属性提供 getting 方法
@Log4j :注解在类上;为类提供一个 属性名为log 的 log4j 日志对象
@NoArgsConstructor:注解在类上;为类提供一个无参的构造方法   @AllArgsConstructor:注解在类上;为类提供一个全参的构造方法

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

讓丄帝愛伱

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值