在spring boot中，摒弃了spring以往项目中大量繁琐的配置，遵循
约定大于配置
的原则，通过自身默认配置，极大的降低了项目搭建的复杂度。同样在spring boot中，大量注解的使用，使得代码看起来更加简洁，提高开发的效率。这些注解不光包括spring boot自有，也有一些是继承自spring的。
本文中将spring boot项目中常用的一些核心注解归类总结，并结合实际使用的角度来解释其作用。整个目录如下，内容有点多：
2.4、@Scop
声明 Spring Bean 的作用域，使用方法:
9、Json数据处理
(长按扫码识别)
1、@SpringBootApplication
这个注解是 Spring Boot 项目的基石，创建 SpringBoot 项目之后会默认在主类加上。@SpringBootApplicationpublic class AppSpringApplication { public static void main(java.lang.String[] args) { SpringApplication.run(AppSpringApplication.class, args); }}package org.springframework.boot.autoconfigure;import java.lang.annotation.Annotation;import java.lang.annotation.Documented;import java.lang.annotation.Inherited;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;import org.springframework.boot.SpringBootConfiguration;import org.springframework.context.annotation.ComponentScan;import org.springframework.core.annotation.AliasFor;@Target({java.lang.annotation.ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@Inherited@SpringBootConfiguration@EnableAutoConfiguration@ComponentScan(excludeFilters={@org.springframework.context.annotation.ComponentScan.Filter(type=org.springframework.context.annotation.FilterType.CUSTOM, classes={org.springframework.boot.context.TypeExcludeFilter.class}), @org.springframework.context.annotation.ComponentScan.Filter(type=org.springframework.context.annotation.FilterType.CUSTOM, classes={AutoConfigurationExcludeFilter.class})})public @interface SpringBootApplication{ @AliasFor(annotation=EnableAutoConfiguration.class) Class>[] exclude() default {}; @AliasFor(annotation=EnableAutoConfiguration.class) String[] excludeName() default {}; @AliasFor(annotation=ComponentScan.class, attribute="basePackages") String[] scanBasePackages() default {}; @AliasFor(annotation=ComponentScan.class, attribute="basePackageClasses") Class>[] scanBasePackageClasses() default {};}package org.springframework.boot;import java.lang.annotation.Annotation;import java.lang.annotation.Documented;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;import org.springframework.context.annotation.Configuration;@Target({java.lang.annotation.ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@Configurationpublic @interface SpringBootConfiguration {}根据 SpringBoot 官网，这三个注解的作用分别是：
@EnableAutoConfiguration：启用SpringBoot的自动配置机制
@ComponentScan：扫描被@Component(@Service,@Controller)注解的 bean，注解默认会扫描该类所在的包下所有的类。
@Configuration：允许在Spring上下文中注册额外的bean或导入其他配置类
2.1、 @Autowired
自动注入对象到类中，被注入进的类同样要被 Spring 容器管理比如：Service 类注入到 Controller 类中。@Servicepublic class UserService {}@RestController@RequestMapping("/user")public class UserController { @Autowired private UserService userService;}@Component ：通用的注解，可标注任意类为Spring组件。如果一个 Bean 不知道属于哪个层，可以使用@Component注解标注。
@Repository : 对应持久层即Dao层，主要用于数据库相关操作。
@Service : 对应服务层，主要涉及一些复杂的逻辑，需要用到Dao层。
@Controller : 对应Spring MVC控制层，主要用户接受用户请求并调用 Service层返回数据给前端页面。
2.3、@RestController
@RestController注解是@Controller和@ResponseBody的合集,表示这是个控制器 bean,并且是将函数的返回值直接填入HTTP响应体中,是REST风格的控制器。?注意：@Controller和@RestController的区别
|
@Bean@Scope("singleton")public Person personSingleton() { return new Person();}四种常见的 Spring Bean 的作用域：
singleton : 唯一 bean 实例，Spring 中的 bean 默认都是单例的。
prototype : 每次请求都会创建一个新的 bean 实例。
request : 每一次 HTTP 请求都会产生一个新的 bean，该 bean 仅在当前 HTTP request 内有效。
session : 每一次 HTTP 请求都会产生一个新的 bean，该 bean 仅在当前 HTTP session 内有效。
@Configurationpublic class AppConfig { @Bean public TransferService transferService() { return new TransferServiceImpl(); }}3、处理常见的HTTP请求类型
5 种常见的请求类型:
GET ：请求从服务器获取特定资源。举个例子
POST ：在服务器上创建一个新的资源。举个例子：POST /users(创建学生)
PUT ：更新服务器上的资源(客户端提供更新后的整个资源)。
DELETE ：从服务器删除特定的资源。
PATCH ：更新服务器上的资源(客户端提供更改的属性，可以看做作是部分更新)，使用的比较少。
@GetMapping("getUsers")等价于@RequestMapping(value="/getUsers",method=RequestMethod.GET)
@GetMapping("/getUsers")public ResponseEntity> getUsers() { return userRepository.findAll();}3.2、POST 请求
@PostMapping("getUsers") 等价于@RequestMapping(value="/getUsers",method=RequestMethod.POST)
GetMapping("/getUsers")public ResponseEntity> getUsers() { return userRepository.findAll();}3.3、PUT 请求
@PutMapping("/users/{userId}") 等价于@RequestMapping(value="/users/{userId}",method=RequestMethod.PUT)
@PutMapping("/users/{userId}")public ResponseEntity updateUser(@PathVariable(value = "userId") Long userId, @Valid @RequestBody UserUpdateRequest userUpdateRequest) {}3.4.、DELETE 请求
@DeleteMapping("/users/{userId}") 等价于 @RequestMapping(value="/users/{userId}",method=RequestMethod.DELETE)@DeleteMapping("/users/{userId}")public ResponseEntity deleteUser(@PathVariable(value = "userId") Long userId){}3.5、PATCH 请求
一般实际项目中，我们都是 PUT 不够用了之后才用 PATCH 请求去更新数据。 @PatchMapping("/profile") public ResponseEntity updateStudent(@RequestBody StudentUpdateRequest studentUpdateRequest) { studentRepository.updateDetail(studentUpdateRequest); return ResponseEntity.ok().build(); }4、 前后端传值
4.1. @PathVariable 和 @RequestParam
@PathVariable用于获取路径参数， @RequestParam用于获取查询参数。@GetMapping("/klasses/{klassId}/teachers")public List getKlassRelatedTeachers(@PathVariable("klassId") Long klassId, @RequestParam(value = "type", required = false) String type ) {}4.2. @RequestBody
用于读取Request 请求(可能是 POST,PUT,DELETE,GET 请求)的 body 部分并且Content-Type 为 application/json格式的数据，接收到数据之后会自动将数据绑定到 Java 对象上去。系统会使用 HttpMessageConverter或者自定义的HttpMessageConverter将请求的 body 中的 json 字符串转换为 java 对象。 举个栗子！假如我们有一个注册接口：@PostMapping("/sign-up")public ResponseEntity signUp(@RequestBody @Valid UserRegisterBean userRegisterbean) { userService.save(userRegisterbean); return ResponseEntity;}@Data@AllArgsConstructor@NoArgsConstructorpublic class UserRegisterBean { @NotBlank private String userName; @NotBlank private String password; @FullName @NotBlank private String fullName;}{"userName":"coder","fullName":"shuangkou","password":"123456"}
? 需要注意的是：一个请求方法只可以有一个@RequestBody，但是可以有多个@RequestParam和@PathVariable。如果你的方法必须要用两个 @RequestBody来接受数据的话，大概率是你的数据库设计或者系统设计出问题了！
5、读取配置信息
很多时候我们需要将一些常用的配置信息比如发送短信、微信认证的相关配置信息等等放到配置文件中。下面我们来看一下 Spring 为我们提供了哪些方式帮助我们从配置文件中读取这些配置信息。我们的数据源application.yml内容如下：maxValue: 99999spring: datasource: driverClassName: com.mysql.jdbc.Driver url: jdbc:mysql://localhost:3306/work_flow?useUnicode=true&characterEncoding=UTF-8 username: root password: root activiti: async-executor-activate: true mail-server-use-ssl: true #自动更新数据库 database-schema-update: true server: port: 8080library: location: 湖北武汉加油中国加油 books: - name: 天才基本法 description: 二十二岁的林朝夕在父亲确诊阿尔茨海默病这天，得知自己暗恋多年的校园男神裴之即将出国深造的消息——对方考取的学校，恰是父亲当年为她放弃的那所。 - name: 时间的秩序 description: 为什么我们记得过去，而非未来？时间“流逝”意味着什么？是我们存在于时间之内，还是时间存在于我们之中？卡洛·罗韦利用诗意的文字，邀请我们思考这一亘古难题——时间的本质。 - name: 了不起的我 description: 如何养成一个新习惯？如何让心智变得更成熟？如何拥有高质量的关系？ 如何走出人生的艰难时刻？5.1、@value(常用)
使用 @Value("${property}") 读取比较简单的配置信息：@Value("${maxValue}")String maxValue;5.2. @ConfigurationProperties(常用)
通过@ConfigurationProperties读取配置信息并与 bean 绑定。@Component@ConfigurationProperties(prefix = "library")class LibraryProperties { @NotEmpty private String location; private List books; @Setter @Getter @ToString static class Book { String name; String description; } 省略getter/setter ......}5.3. PropertySource(不常用)
@PropertySource读取指定 properties 文件@Component@PropertySource("classpath:application.properties")class WebSite { @Value("${url}") private String url; 省略getter/setter ......}6、参数校验
数据的校验的重要性就不用说了，即使在前端对数据进行校验的情况下，我们还是要对传入后端的数据再进行一遍校验，避免用户绕过浏览器直接通过一些 HTTP 工具直接向后端请 求一些违法数据。 校验的时候我们实际用的是 Hibernate Validator 框架。Hibernate Validator 是 Hibernate 团队最初的数据校验框架，Hibernate Validator 4.x 是 Bean Validation 1.0(JSR 303)的参考实现，Hibernate Validator 5.x 是 Bean Validation 1.1(JSR 349)的参考实现，目前最新版的 Hibernate Validator 6.x 是 Bean Validation 2.0(JSR 380)的参考实现。 SpringBoot项目的spring-boot-starter-web依赖中已经有hibernate-validator 包，不需要引用相关依赖。如下图所示：
? 需要注意的是：所有的注解，推荐使用 JSR 注解，即javax.validation.constraints，而不是org.hibernate.validator.constraints
6.1、一些常用的字段验证的注解
- @NotEmpty 被注释的字符串的不能为 null 也不能为空
- @NotBlank 被注释的字符串非 null，并且必须包含一个非空白字符
- @Null 被注释的元素必须为 null
- @NotNull 被注释的元素必须不为 null
- @AssertTrue 被注释的元素必须为 true
- @AssertFalse 被注释的元素必须为 false
- @Pattern(regex=,flag=)被注释的元素必须符合指定的正则表达式
- @Email 被注释的元素必须是 Email 格式。
- @Min(value)被注释的元素必须是一个数字，其值必须大于等于指定的最小值
- @Max(value)被注释的元素必须是一个数字，其值必须小于等于指定的最大值
- @DecimalMin(value)被注释的元素必须是一个数字，其值必须大于等于指定的最小值
- @DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
- @Size(max=, min=)被注释的元素的大小必须在指定的范围内
- @Digits (integer, fraction)被注释的元素必须是一个数字，其值必须在可接受的范围内
- @Past被注释的元素必须是一个过去的日期
- @Future 被注释的元素必须是一个将来的日期
- ......
6.2、 验证请求体(RequestBody)
@Data@AllArgsConstructor@NoArgsConstructorpublic class Person { @NotNull(message = "classId 不能为空") private String classId; @Size(max = 33) @NotNull(message = "name 不能为空") private String name; @Pattern(regexp = "((^Man$|^Woman$|^UGM$))", message = "sex 值不在可选范围") @NotNull(message = "sex 不能为空") private String sex; @Email(message = "email 格式不正确") @NotNull(message = "email 不能为空") private String email;}我们在需要验证的参数上加上了@Valid注解，如果验证失败，它将抛出MethodArgumentNotValidException。
@RestController@RequestMapping("/api")public class PersonController { @PostMapping("/person") public ResponseEntity getPerson(@RequestBody @Valid Person person) { return ResponseEntity.ok().body(person); }}6.3. 验证请求参数(Path Variables 和 Request Parameters)
一定一定不要忘记在类上加上@Validated 注解了，这个参数可以告诉 Spring 去校验方法参数。@RestController@RequestMapping("/api")@Validatedpublic class PersonController { @GetMapping("/person/{id}") public ResponseEntity getPersonByID(@Valid @PathVariable("id") @Max(value = 5,message = "超过 id 的范围了") Integer id) { return ResponseEntity.ok().body(id); }}7、JPS相关
7.1、创建表
@Entity声明一个类对应要给数据库实体。
@Table设置表明
@Entity@Table(name = "role")public class Role { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; private String name; private String description; 省略getter/setter......}7.2、创建主键
@Id ：声明一个字段为主键。 使用 @Id 声明之后，我们还需要定义主键的生成策略。我们可以使用 @GeneratedValue 指定主键生成策略。 1、通过 @GeneratedValue 直接使用 JPA 内置提供的四种主键生成策略来指定主键生成策略。@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;public enum GenerationType { /** * 使用一个特定的数据库表格来保存主键 * 持久化引擎通过关系数据库的一张特定的表格来生成主键, */ TABLE, /** *在某些数据库中,不支持主键自增长,比如Oracle、PostgreSQL其提供了一种叫做"序列(sequence)"的机制生成主键 */ SEQUENCE, /** * 主键自增长 */ IDENTITY, /** *把主键生成策略交给持久化引擎(persistence engine), *持久化引擎会根据数据库在以上三种主键生成 策略中选择其中一种 */ AUTO}2、通过 @GenericGenerator声明一个主键策略，然后 @GeneratedValue使用这个策略
@Id@GeneratedValue(generator = "IdentityIdGenerator")@GenericGenerator(name = "IdentityIdGenerator", strategy = "identity")private Long id;等价于：
@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;jpa 提供的主键生成策略有如下几种：
public class DefaultIdentifierGeneratorFactory implements MutableIdentifierGeneratorFactory, Serializable, ServiceRegistryAwareService { @SuppressWarnings("deprecation") public DefaultIdentifierGeneratorFactory() { register( "uuid2", UUIDGenerator.class ); register( "guid", GUIDGenerator.class ); // can be done with UUIDGenerator + strategy register( "uuid", UUIDHexGenerator.class ); // "deprecated" for new use register( "uuid.hex", UUIDHexGenerator.class ); // uuid.hex is deprecated register( "assigned", Assigned.class ); register( "identity", IdentityGenerator.class ); register( "select", SelectGenerator.class ); register( "sequence", SequenceStyleGenerator.class ); register( "seqhilo", SequenceHiLoGenerator.class ); register( "increment", IncrementGenerator.class ); register( "foreign", ForeignGenerator.class ); register( "sequence-identity", SequenceIdentityGenerator.class ); register( "enhanced-sequence", SequenceStyleGenerator.class ); register( "enhanced-table", TableGenerator.class ); } public void register(String strategy, Class generatorClass) { LOG.debugf( "Registering IdentifierGenerator strategy [%s] -> [%s]", strategy, generatorClass.getName() ); final Class previous = generatorStrategyToClassNameMap.put( strategy, generatorClass ); if ( previous != null ) { LOG.debugf( " - overriding [%s]", previous.getName() ); } }}7.3、设置字段类型
@Column 声明字段。 示例：设置属性 userName 对应的数据库字段名为 user_name，长度为 32，非空@Column(name = "user_name", nullable = false, length=32)private String userName;设置字段类型并且加默认值，这个还是挺常用的。
@Column(columnDefinition = "tinyint(1) default 1")private Boolean enabled;7.4、 指定不持久化特定字段
@Transient ：声明不需要与数据库映射的字段，在保存的时候不需要保存进数据库 。如果我们想让secrect 这个字段不被持久化，可以使用 @Transient 关键字声明。Entity(name="USER")public class User { ...... @Transient private String secrect; // not persistent because of @Transient}除了 @Transient关键字声明， 还可以采用下面几种方法(一般使用注解的方式比较多)：
static String secrect; // not persistent because of staticfinal String secrect = “Satish”; // not persistent because of finaltransient String secrect; // not persistent because of transient7.5、声明大字段
@Lob:声明某个字段为大字段。
@Lobprivate String content;更详细的声明：
@Lob//指定 Lob 类型数据的获取策略， FetchType.EAGER 表示非延迟 加载，而 FetchType. LAZY 表示延迟加载 ；@Basic(fetch = FetchType.EAGER)//columnDefinition 属性指定数据表对应的 Lob 字段类型@Column(name = "content", columnDefinition = "LONGTEXT NOT NULL")private String content;7.6、删除/修改数据
@Modifying注解提示JPA 该操作是修改操作,注意还要配合 @Transactional注解使用。@Repositorypublic interface UserRepository extends JpaRepository { @Modifying @Transactional(rollbackFor = Exception.class) void deleteByUserName(String userName);}@OneToOne声明一对一关系
@OneToMany 声明一对多关系
@ManyToOne声明多对一关系
@MangToMang声明多对多关系
8、事务 @Transactional
在要开启事务的方法上使用@Transactional注解即可!
@Transactional(rollbackFor = Exception.class)public void save() { ......}我们知道 Exception 分为运行时异常 RuntimeException 和非运行时异常。在@Transactional注解中如果不配置rollbackFor属性,那么事物只会在遇到RuntimeException的时候才会回滚,加上rollbackFor=Exception.class,可以让事物在遇到非运行时异常时也回滚。 @Transactional 注解一般用在可以作用在类或者方法上。
|
9.1、过滤json数据
@JsonIgnoreProperties 作用在类上用于过滤掉特定字段不返回或者不解析。//生成json时将userRoles属性过滤@JsonIgnoreProperties({"userRoles"})public class User { private String userName; private String fullName; private String password; @JsonIgnore private List userRoles = new ArrayList<>();}@JsonIgnore一般用于类的属性上，作用和上面的@JsonIgnoreProperties 一样。
public class User { private String userName; private String fullName; private String password; //生成json时将userRoles属性过滤 @JsonIgnore private List userRoles = new ArrayList<>();}9.2、格式化 json 数据
@JsonFormat一般用来格式化 json 数据。
@JsonFormat(shape=JsonFormat.Shape.STRING, pattern="yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", timezone="GMT")private Date date;9.3、扁平化对象
Getter@Setter@ToStringpublic class Account { @JsonUnwrapped private Location location; @JsonUnwrapped private PersonInfo personInfo; @Getter @Setter @ToString public static class Location { private String provinceName; private String countyName; } @Getter @Setter @ToString public static class PersonInfo { private String userName; private String fullName; }}{ "location": { "provinceName":"湖北", "countyName":"武汉" }, "personInfo": { "userName": "coder1234", "fullName": "shaungkou" }}@Getter@Setter@ToStringpublic class Account { @JsonUnwrapped private Location location; @JsonUnwrapped private PersonInfo personInfo; ......}{ "provinceName":"湖北", "countyName":"武汉", "userName": "coder1234", "fullName": "shaungkou"}@SpringBootTest(webEnvironment = RANDOM_PORT)@ActiveProfiles("test")@Slf4jpublic abstract class TestBase { ......} @Test @Transactional @WithMockUser(username = "user-id-18163138155", authorities = "ROLE_TEACHER") void should_import_student_success() throws Exception { ...... }以上是小星给大家整理的常用SpringBoot注解，希望对小伙伴们学习和使用SpringBoot有帮助。
本公众号会不定时给小伙伴们带来java实用技术分享，喜欢的小伙伴欢迎关注小星的公众号。
(长按扫码识别)
扫一扫
617
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
