SpringBoot常用注解

1.SpringBoot/Spring

@SpringBootApplication:

包含@Configuration@EnableAutoConfiguration@ComponentScan通常用在主类上。

@Repository:

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

@Service:

用于标注业务层组件。

@Controller:

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

@RestController:

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

@Component:

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

@ResponseBody:

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

@RequestBody:

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

@ComponentScan:

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

@Configuration:

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

@Bean:

相当于XML中的<bean>标签,放在方法的上面而不是类,意思是产生一个bean,并交给Spring管理。

@EnableAutoConfiguration:

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

@Autowired:

byType方式。把配置好的 Bean 拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。

当加上(required=false)时,就算找不到bean也不报错。

@Qualifier:

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

例如:

@Autowired(required = false)
private Date date;

@Autowired
@Qualifier("birth")
private Date birthday;

@Resource(name="name", type="type"):

没有括号内内容的话,默认按照名称进行装配,可以通过name属性指定名称,如果没有指定name属性,当注解写在字段上时,默认取字段名进行查找注入,如果写在setter方法上默认取属性名进行装配。当找不到与名称匹配的bean时才按照类型进行装配。但是需要注意的是,如果name属性一旦指定,就只会按照名称进行装配。

@RequestMapping:

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

该注解有六个属性:

params:指定request中必须包含某些参数值时才让该方法处理。

headers:指定request中必须包含某些指定的header值,才能让该方法处理请求。

value:指定请求的实际地址,指定的地址可以时具体地址、可以是Restful动态获取,也可以使用正则设置。

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:

路径变量。

@GetMapping("/user/{userId}")
public String getUserInfor(@PathVariable("userId") Long userId){
    //TODO 业务逻辑
}

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

2.Jpa

@Entity:

@Table(name=""):

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

@MappedSuperClass:

用在确定是父类的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配置文件中的一对一,一对多,多对一。

3.全局异常处理

@ControllerAdvice:

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

@ExceptionHandler(Exception.class)

用在方法上面表示遇到这个异常就执行以下方法。

4.SpringCloud

@EnableEurekaServer:

用在SpringBoot启动类上,表示这是一个Eureka服务注册中心。

@EnableDiscoveryClient:

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

@LoadBalanced:

开启负载均衡能力。

@EnableCircuitBreaker

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

@HystrixCommand(fallbackMethod="backMethod"):

用在方法上,fallbackMethod指定断路回调方法。

@EnableConfigServer:

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

@EnableZuulProxy:

开启zuul路由,用在启动类上。

@SpringCloudApplication:

包含:@SpringBootApplication@EnableDiscovertyClient@EnableCircuitBreaker 分别时SpringBoot注解、注册服务中心Eureka注解、断路器注解。对于SpringCloud来说,这是每个微服务必须应有的三个注解,所以才推出了@SpringCloudApplication这一注解集合。

原文引自:CSDN,作者:Wakfu 链接:https://blog.csdn.net/sbuiwqvb123/article/details/70331956

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,546评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,224评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,911评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,737评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,753评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,598评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,338评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,249评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,696评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,888评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,013评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,731评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,348评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,929评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,048评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,203评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,960评论 2 355

推荐阅读更多精彩内容