常用注解

应用上下文

AutoWired

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

@Bean

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

@ComponentScan

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

@Configuration

指出该类是Bean配置的信息源，相当于XML中的，一般加在主类上；

@Component

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

@EnableAutoConfiguration

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

@Qualifier

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

@Repository

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

@Resource(name=”name”,type=”type”)

没有括号内内容的话，默认byName。与@Autowired干类似的事。

@SpringBootApplication

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

请求响应与服务

@Controller & @RestController

用于标注是控制层组件，需要返回页面时请用@Controller而不是@RestController。@RestController则用于标注控制层组件(如struts中的action)，包含@Controller和@ResponseBody。

@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.GetPostPutDelete) 等。是个组合注解；

@RequestParam & @PathVariable & @RequestBody

@RequestParam用在方法的参数前面。相当于request.getParameter；@RequestBody参数前加上这个注解之后，认为该参数必填。表示接受json字符串转为对象List等。@PathVariable则是路径变量：

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

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

@ResponseBody

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

@Service

用于标注业务层组件。

数据访问

Jpa

@Entity & @Table(name=”“)

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

@MappedSuperClass

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

@NoRepositoryBean

一般用作父类的repository，有这个注解，Spring不会去实例化该repository；

@Column & @Id

如果字段名与列名相同，则可以省略。@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”)

Spring Cloud

@SpringCloudApplication

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

@EnableEurekaServer

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

@EnableDiscoveryClient

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

@LoadBalanced

开启负载均衡能力。

@EnableCircuitBreaker

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

@HystrixCommand(fallbackMethod=”backMethod”)

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

@EnableConfigServer

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

@EnableZuulProxy

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

其他

服务与异常处理

@ControllerAdvice

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

@ExceptionHandler(Exception.class)

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

Links

最近更新于0001-01-01