前言:SpringBoot之所以显得很好用、很方便,其原因之一就在于注解的使用。SpringBoot为我们提供了很多内置注解,给我们提供了很好的工具。

一.什么是注解

在JDK5版本后Java添加了对注解的支持,像我们用到的@Override之类的标识就是注解。使用注解的原因:在不改变原有代码的情况下,拓展方法的功能。

注解可以用在类、字段变量、方法、接口等位置。

举个例子,如果我们重写了toString()方法

1
2
3
4
@Override
public String toString() {
return "This is a toString method.";
}

这个方法上面的标识@Override会告诉编译器这个方法是重写的,若父类没有这个方法编译器便会报错,是不是很方便?

二.SpringBoot常用注解

@Component:泛指组件,可配合CommandLineRunner使用,在程序启动后执行一些基础任务。
@RequestMapping:提供路由信息,负责URL到Controller中的具体函数的映射,方法返回值通常解析为跳转路径。
@ResponseBody:该注解一般会配合@RequestMapping一起使用,返回结果不会被解析为跳转路径,而是直接写入HTTP response body中,比如异步获取json数据,会直接返回json数据。
@Controller:用于定义控制器类,在Spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层),一般这个注解在类中,通常配合注解@RequestMapping:参数较复杂,后有详细说明
@RestController:用于标注控制层组件,是@Controller和@ResponseBody的合集,表示这是个控制器bean,并且是将函数的返回值直接填入HTTP响应体中,是REST风格的控制器。
@SpringBootApplication:让Spring Boot自动给程序进行必要的配置,是@ComponentScan、@Configuration以及@EnableAutoConfiguration的集合。新建工程后,*Application的入口类就自动添加了这个注解。
@ComponentScan:让Spring Boot扫描到Configuration类并把它加入到程序上下文。
@Configuration:等同于Spring的XML配置文件,使用Java代码可以检查类型安全,如果有些第三方库需要用到xml文件,建议仍然通过@Configuration类作为项目的配置主类。
@EnableAutoConfiguration:根据添加的jar依赖自动配置你的Spring应用。
@Service:一般用于修饰service层的组件。
@Repository:使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供XML配置项。
@Bean:用@Bean标注方法等价于XML中配置的bean,放在方法的上面,而不是类,意思是产生一个bean,并交给spring管理。
@Autowired:自动导入依赖的bean,把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作,当加上(required=false)时,就算找不到bean也不报错。
@Qualifier:当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定,与@Autowired配合使用,@Qualifier限定描述符除了能根据名字进行注入,也能进行更细条件的指定。
@Inject:等价于默认的@Autowired,只是没有required属性。
@Resource(name=”name”,type=”type”):没有括号内内容的话,默认byName。与@Autowired干类似的事。
@Import:用来导入其他配置类。
@ImportResource:用来加载xml配置文件。
@Value:注入application.properties配置的属性的值。
@PathVariable:路径变量。
@JsonBackReference解决嵌套外链问题。
@RequestParam:用在方法的参数前面。

对于@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类型中包含该指定类型才返回。

三.常用的JPA注解

@Entity:@Table(name=””):表明这是一个实体类。这两个注解一般一块使用,但是如果表名和实体类名相同的话,@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框架将忽略该属性。
@JsonIgnore:作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。
@JoinColumn(name=”loginId”):一对一:本表中指向另一个表的外键。一对多:另一个表指向本表的外键。
@OneToOne、@OneToMany、@ManyToOne:对应hibernate配置文件中的一对一,一对多,多对一。

四.异常处理注解

@ControllerAdvice:统一处理异常。
@ExceptionHandler(Exception.class):用在方法上面表示遇到这个异常就执行以下方法。

五.自定义注解

引出问题

上面列举了一大堆花里胡哨的注解后,你是不是也想实现一个属于自己的注解了呢?

假设我们有下面一个Phone类

1
2
3
4
5
public class phone{
private Long id; //手机编号
private String name; //手机型号
private double price; //手机价格
}

如果我们要对传入的数据做校验,你是不是首先想到用if语句去判断?例如:

1
2
if(id.length!=8)
return "手机编号应为8位"

这样会使我们的代码变得臃肿,不够简洁美观,这时我们可以用@Length注解,加载对应的实体类参数上即可。那么怎么自己实现一个呢?

STEP1 —— 定义注解

1
2
3
4
5
6
7
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Length{
int min();// 允许字符串长度的最小值
int max();// 允许字符串长度的最大值
String errorMsg();// 自定义的错误提示信息
}

1.注解中的成员变量只可以用基本类型,不能用包装类

2.@Target用来说明该注解用在什么位置

参数 描述
ElementType.FIELD 类的变量
ElementType.METHOD 类的方法
ElementType.TYPE 类、接口

3.@Retention说明注解的生命周期

参数 说明
RetentionPolicy.RUNTIME 一直保留到运行时
RetentionPolicy.CLASS 编译进class文件,运行时忽略
RetentionPolicy.SOURCE 源文件有效,编译时忽略

STEP2——对参数进行验证

下面会用到Java的反射知识

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
public static String validate(Object object) throws IllegalAccessException {

// 首先通过反射获取obj ect对象的类有哪些字段
// 对本文来 说就可以获取到Student类的id、name、mobile三个字段
Field[] fields = object.getClass().getDeclaredFields();

// for循环逐个字段校验,看哪个字段上标了注解
for(Field field : fields){

// if判断: 检查该字段上有没有标注了@Length注解
if(field.isAnnotationPresent(Length.class)){

// 通过反射获取到该字段上标注的@Length注解的详细信息
Length length = field.getAnnotation(Length.class);

// 让我们在反射时能访问到私有变量
field. setAccessible(true);

// 用过反射获取字段的实际值
int value =((String)field.get(object)).length();

// 将字段的实际值和注解上做标示的值进行比对
if(value<length.min() || value>length.max()){
return length.errorMsg();
}
}
}
return null;
}

STEP3——愉快的使用注解

1
2
3
4
5
6
public class phone{
@Length(min=8,max=8,errorMsg="手机编号应为8位")
private Long id; //手机编号
private String name; //手机型号
private double price; //手机价格
}

大家学会了吗~?