浅谈springBoot注解大全

一、注解(annotations)列表

@springbootapplication：包含了@componentscan、@configuration和@enableautoconfiguration注解。其中@componentscan让spring boot扫描到configuration类并把它加入到程序上下文。

@configuration 等同于spring的xml配置文件；使用java代码可以检查类型安全。

@enableautoconfiguration 自动配置。

@componentscan 组件扫描，可自动发现和装配一些bean。

@component可配合commandlinerunner使用，在程序启动后执行一些基础任务。

@restcontroller注解是@controller和@responsebody的合集,表示这是个控制器bean,并且是将函数的返回值直 接填入http响应体中,是rest风格的控制器。

@autowired自动导入。

@pathvariable获取参数。

@jsonbackreference解决嵌套外链问题。

@repositoryrestresourcepublic配合spring-boot-starter-data-rest使用。

二、注解(annotations)详解

@springbootapplication：申明让spring boot自动给程序进行必要的配置，这个配置等同于：@configuration ，@enableautoconfiguration 和 @componentscan 三个配置。

package com.example.myproject; 
import org.springframework.boot.springapplication; 
import org.springframework.boot.autoconfigure.springbootapplication;

@springbootapplication // same as @configuration @enableautoconfiguration @componentscan 
public class application { 
public static void main(string[] args) { 
springapplication.run(application.class, args); 
} 
}

@responsebody：表示该方法的返回结果直接写入http response body中，一般在异步获取数据时使用，用于构建restful的api。在使用@requestmapping后，返回值通常解析为跳转路径，加上@responsebody后返回结果不会被解析为跳转路径，而是直接写入http response body中。比如异步获取json数据，加上@responsebody后，会直接返回json数据。该注解一般会配合@requestmapping一起使用。示例代码：

@requestmapping(“/test”) 
@responsebody 
public string test(){ 
return”ok”; 
}

@controller：用于定义控制器类，在spring 项目中由控制器负责将用户发来的url请求转发到对应的服务接口（service层），一般这个注解在类中，通常方法需要配合注解@requestmapping。示例代码：

@controller 
@requestmapping(“/demoinfo”) 
publicclass democontroller { 
@autowired 
private demoinfoservice demoinfoservice;

@requestmapping("/hello")
public string hello(map<string,object> map){
  system.out.println("democontroller.hello()");
  map.put("hello","from templatecontroller.hellohtml");
  //会使用hello.html或者hello.ftl模板进行渲染显示.
  return"/hello";
}
}

@restcontroller：用于标注控制层组件(如struts中的action)，@responsebody和@controller的合集。示例代码：

package com.kfit.demo.web;

import org.springframework.web.bind.annotation.requestmapping; 
import org.springframework.web.bind.annotation.restcontroller;


@restcontroller 
@requestmapping(“/demoinfo2”) 
publicclass democontroller2 {

@requestmapping("/test")
public string test(){
  return"ok";
}
}

@requestmapping：提供路由信息，负责url到controller中的具体函数的映射。

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

@componentscan：表示将该类自动发现扫描组件。个人理解相当于，如果扫描到有@component、@controller、@service等这些注解的类，并注册为bean，可以自动收集所有的spring组件，包括@configuration类。我们经常使用@componentscan注解搜索beans，并结合@autowired注解导入。可以自动收集所有的spring组件，包括@configuration类。我们经常使用@componentscan注解搜索beans，并结合@autowired注解导入。如果没有配置的话，spring boot会扫描启动类所在包下以及子包下的使用了@service,@repository等注解的类。

@configuration：相当于传统的xml配置文件，如果有些第三方库需要用到xml文件，建议仍然通过@configuration类作为项目的配置主类——可以使用@importresource注解加载xml配置文件。

@import：用来导入其他配置类。

@importresource：用来加载xml配置文件。

@autowired：自动导入依赖的bean

@service：一般用于修饰service层的组件

@repository：使用@repository注解可以确保dao或者repositories提供异常转译，这个注解修饰的dao或者repositories类会被componetscan发现并配置，同时也不需要为它们提供xml配置项。

@bean：用@bean标注方法等价于xml中配置的bean。

@value：注入spring boot application.properties配置的属性的值。示例代码：

@value(value = “#{message}”) 
private string message;

@inject：等价于默认的@autowired，只是没有required属性；

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

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

@autowired：自动导入依赖的bean。bytype方式。把配置好的bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。当加上（required=false）时，就算找不到bean也不报错。

@qualifier：当有多个同一类型的bean时，可以用@qualifier(“name”)来指定。与@autowired配合使用。@qualifier限定描述符除了能根据名字进行注入，但能进行更细粒度的控制如何选择候选者，具体使用方式如下：

@autowired 
@qualifier(value = “demoinfoservice”) 
private demoinfoservice demoinfoservice;

@resource(name=”name”,type=”type”)：没有括号内内容的话，默认byname。与@autowired干类似的事。

三、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配置文件中的一对一，一对多，多对一。

四、springmvc相关注解

@requestmapping：@requestmapping(“/path”)表示该控制器处理所有“/path”的ur l请求。requestmapping是一个用来处理请求地址映射的注解，可用于类或方法上。 

用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。该注解有六个属性：

1. params:指定request中必须包含某些参数值是，才让该方法处理。
2. headers:指定request中必须包含某些指定的header值，才能让该方法处理请求。
3. value:指定请求的实际地址，指定的地址可以是uri template 模式
4. method:指定请求的method类型， get、post、put、delete等
5. consumes:指定处理请求的提交内容类型（content-type），如application/json,text/html;
6. produces:指定返回的内容类型，仅当request请求头中的(accept)类型中包含该指定类型才返回

@requestparam：用在方法的参数前面。

@requestparam 
 string a =request.getparameter(“a”)。

@pathvariable:路径变量。如 

requestmapping(“user/get/mac/{macaddress}”) 
public string getbymacaddress(@pathvariable string macaddress){ 
//do something; 
} 

参数与大括号里的名字一样要相同。

五、全局异常处理

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

@exceptionhandler（exception.class）：用在方法上面表示遇到这个异常就执行以下方法。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。