码迷,mamicode.com
首页 > 其他好文 > 详细

学习-常用注解

时间:2019-12-10 13:35:10      阅读:104      评论:0      收藏:0      [点我收藏+]

标签:break   contex   一对一   字符   source   wired   content   固定   报错   

常用注解

@SpringBootApplication
@SpringBootApplication是一个复合注解,包括@ComponentScan,和@SpringBootConfiguration,@EnableAutoConfiguration

  • @SpringBootConfiguration继承自@Configuration,二者功能也一致,标注当前类是配置类,并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到srping容器中,并且实例名就是方法名
  • @EnableAutoConfiguration的作用启动自动的配置。
  • @EnableAutoConfiguration注解的意思就是Springboot根据你添加的jar包来配置你项目的默认配置,比如根据spring-boot-starter-web ,来判断你的项目是否需要添加了webmvc和tomcat,就会自动的帮你配置web项目中所需要的默认配置。
  • @ComponentScan,扫描当前包及其子包下被@Component,@Controller,@Service,@Repository注解标记的类并纳入到spring容器中进行管理。

@EnableJpaRepositories
@EnableJpaRepositories注解用于Srping JPA的代码配置,用于取代xml形式的配置文件

@EnableAspectJAutoProxy
表示开启AOP代理自动配置,如果配@EnableAspectJAutoProxy表示使用cglib进行代理对象的生成;设置@EnableAspectJAutoProxy(exposeProxy=true)表示通过aop框架暴露该代理对象,aopContext能够访问

@EnableScheduling & @Scheduled
定时任务在配置类上添加@EnableScheduling开启对定时任务的支持,在相应的方法上添加@Scheduled声明需要执行的定时任务。
其中Scheduled注解中有以下几个参数:

  • cron;
  • zone;
  • fixedDelay和fixedDelayString;
  • fixedRate和fixedRateString;
  • initialDelay和initialDelayString
  1. cron 是设置定时执行的表达式,如 0 0/5 * * * ?每隔五分钟执行一次
  2. zone 表示执行时间的时区
  3. fixedDelay和fixedDelayString 表示一个固定延迟时间执行,上个任务完成后,延迟多长时间执行
  4. fixedRate 和fixedRateString 表示一个固定频率执行,上个任务开始后,多长时间后开始执行
  5. initialDelay 和initialDelayString 表示一个初始延迟时间,第一次被调用前延迟的时间

@ConditionalOnProperty
控制某个configuration是否生效。具体操作是通过其两个属性name以及havingValue来实现的,其中name用来从application.properties中读取某个属性值,如果该值为空,则返回false;如果值不为空,则将该值与havingValue指定的值进行比较,如果一样则返回true;否则返回false。如果返回值为false,则该configuration不生效;为true则生效。

@PathVariable
@PathVariable绑定URI模板变量值
@PathVariable是用来获得请求url中的动态参数的
@PathVariable用于将请求URL中的模板变量映射到功能处理方法的参数上

@Repository
用于标注数据访问组件,即DAO组件。

@Service
用于标注业务层组件。

@RestController
用于标注控制层组件(如struts中的action),包含@Controller和@ResponseBody

@Controller
用于标注是控制层组件,需要返回页面时请用@Controller而不是@RestController

@Component
泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。

@ResponseBody
表示该方法的返回结果直接写入HTTP response body中。
一般在异步获取数据时使用,在使用@RequestMapping后,返回值通常解析为跳转路径,加上@responsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。
比如异步获取json数据,加上@responsebody后,会直接返回json数据

@RequestBody
参数前加上这个注解之后,认为该参数必填。表示接受json字符串转为对象 List等。

@ComponentScan
组件扫描。个人理解相当于,如果扫描到有@Component 、@Controller、@Service等这些注解的类,则把这些类注册为bean

@Configuration
指出该类是 Bean 配置的信息源,相当于XML中的,一般加在主类上。

@Bean
相当于XML中的,放在方法的上面,而不是类,意思是产生一个bean,并交给spring管理

@EnableAutoConfiguration
让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置,一般加在主类上

@AutoWired
byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错

@Qualifier
当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用

@Resource(name=”name”,type=”type”)
没有括号内内容的话,默认byName。与@Autowired干类似的事

@RequestMapping
RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。
该注解有六个属性:

  • params:指定request中必须包含某些参数值是,才让该方法处理。
  • headers:指定request中必须包含某些指定的header值,才能让该方法处理请求。
  • value:指定请求的实际地址,指定的地址可以是URI Template 模式
  • method:指定请求的method类型, GET、POST、PUT、DELETE等
  • consumes:指定处理请求的提交内容类型(Content-Type),如application/json,text/html;
  • produces:指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回

@GetMapping、@PostMapping等
相当于@RequestMapping(value=”/”,method=RequestMethod.Get\Post\Put\Delete等) 。是个组合注解

@RequestParam
用在方法的参数前面。相当于 request.getParameter()。

@PathVariable:
路径变量。如

    RequestMapping(“user/get/mac/{macAddress}”) 
    public String getByMacAddress(@PathVariable(“macAddress”) String macAddress){ 
        //do something; 
    } 

参数与大括号里的名字相同的话,注解后括号里的内容可以不填


Jpa相关

@Entity:
@Table(name=”“)

表明这是一个实体类。一般用于jpa;
这两个注解一般一块使用,但是如果表名和实体类名相同的话,@Table可以省略

@MappedSuperClass
用在确定是父类的entity上。父类的属性子类可以继承。

@NoRepositoryBean
一般用作父类的repository,有这个注解,spring不会去实例化该repository

@Column
如果字段名与列名相同,则可以省略

@Id
表示该属性为主键

@GeneratedValue(strategy = GenerationType.SEQUENCE,generator ="repair_seq")
表示主键生成策略是sequence(可以为Auto、IDENTITY、native等,Auto表示可在多个数据库间切换),指定sequence的名字是repair_seq

@SequenceGeneretor(name="repair_seq",sequenceName="seq_repair",allocationSize=1)
name为sequence的名称,以便使用,sequenceName为数据库的sequence名称,两个名称可以一致

@Transient
表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性.
如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic

@Basic(fetch=FetchType.LAZY)
标记可以指定实体属性的加载方式

@JsonIgnore
作用是json序列化时将java bean中的一些属性忽略掉,序列化和反序列化都受影响

@JoinColumn(name="loginId")
一对一:本表中指向另一个表的外键。
一对多:另一个表指向本表的外键。

@OneToOne
@OneToMany
@ManyToOne

对应Hibernate配置文件中的一对一,一对多,多对一


全局异常处理相关

@ControllerAdvice
包含@Component。可以被扫描到。统一处理异常

@ExceptionHandler(Exception.class)
用在方法上面表示遇到这个异常就执行以下方法

springcloud相关

@EnableEurekaServer
用在springboot启动类上,表示这是一个eureka服务注册中心

@EnableDiscoveryClient
用在springboot启动类上,表示这是一个服务,可以被注册中心找到

@LoadBalanced
开启负载均衡能力

@EnableCircuitBreaker
用在启动类上,开启断路器功能

@HystrixCommand(fallbackMethod="backMethod")
用在方法上,fallbackMethod指定断路回调方法

@EnableConfigServer
用在启动类上,表示这是一个配置中心,开启Config Server

@EnableZuulProxy
开启zuul路由,用在启动类上

@SpringCloudApplication
包含@SpringBootApplication、@EnableDiscoveryClient、@EnableCircuitBreaker这三个注解

学习-常用注解

标签:break   contex   一对一   字符   source   wired   content   固定   报错   

原文地址:https://www.cnblogs.com/zd-blogs/p/12015906.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!