Spring框架相关注解大全

Spring框架相关常用注解大全

一、Spring 注解

@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) 详解

三、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”的URL请求。
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) 类型中包含该指定类型才返回

@RequestParam

将请求参数绑定到你控制器的方法参数上（是springmvc中接收普通参数的注解

语法：

@RequestParam(value=”参数名”,required=”true/false”,defaultValue=””)
value：参数名 
required：是否包含该参数，默认为true，表示该请求路径中必须包含该参数，如果不包含就报错。
defaultValue：默认参数值，如果设置了该值，required=true将失效，自动为false,如果没有传该参数，就使用默认值

public ModelAndView test(@RequestParam("name") String name){
        ModelAndView mv = new ModelAndView();
        mv.setViewName("hello2");
        mv.addObject("msg", "接收普通的请求参数：" + name);
        return mv;
}

@PathVariable

路径变量。如

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

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

五、全局异常处理

@ControllerAdvice

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

@ExceptionHandler（Exception.class）

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