Java 中高级核心知识全面解析——常用框架 (Spring 常用注解
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|^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<Person> getPerson(@RequestBody @Valid Person person) {return ResponseEntity.ok().body(person);}}
3.验证请求参数(Path Variables 和 Request Parameters)
一定一定不要忘记在类上加上 Validated
注解了,这个参数可以告诉 Spring 去校验方法参数。
@RestController@RequestMapping("/api")@Validatedpublic class PersonController {
@GetMapping("/person/{id}")public ResponseEntity<Integer> getPersonByID(@Valid @PathVariable("id") @Max(value = 5,message = "超过 id 的范围了") Integer id) {return ResponseEntity.ok().body(id);}}
七、全局处理 Controller 层异常
介绍一下我们 Spring 项目必备的全局处理 Controller 层异常。
相关注解:
@ControllerAdvice
:注解定义全局异常处理类@ExceptionHandler
:注解声明异常处理方法
如何使用呢?拿我们在第 5 节参数校验这块来举例子。如果方法参数不对的话就会抛出 MethodArgumentNotValidException
,我们来处理这个异常。
@ControllerAdvice@ResponseBodypublic class GlobalExceptionHandler {
/**
请求参数异常处理*/@ExceptionHandler(MethodArgumentNotValidException.class)public ResponseEntity<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex, HttpServletRequest request) {......}}
八、JPA 相关
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......}
2.创建主键
@Id
:声明一个字段为主键。
使用 @Id
声明之后,我们还需要定义主键的生成策略。我们可以使用 @GeneratedValue
指定主键生成策略。
1.通过 @GeneratedValue
直接使用 JPA 内置提供的四种主键生成策略来指定主键生成策略。
@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;
JPA 使用枚举定义了 4 中常见的主键生成策略,如下:
public enum GenerationType {/**
使用一个特定的数据库表格来保存主键
持久化引擎通过关系数据库的一张特定的表格来生成主键,*/TABLE,
/***在某些数据库中,不支持主键自增长,比如 Oracle、PostgreSQL 其提供了一种叫做"序列 (sequence)"的机制生成主键*/SEQUENCE,
/**
主键自增长*/IDENTITY,
/***把主键生成策略交给持久化引擎(persistence engine),*持久化引擎会根据数据库在以上三种主键生成 策略中选择其中一种*/AUTO
}
@GeneratedValue
注解默认使用的策略是 GenerationType.AUTO
public @interface GeneratedValue {
GenerationType strategy() default AUTO;String generator() default "";}
一般使用 MySQL 数据库的话,使用 GenerationType.IDENTITY
策略比较普遍一点(分布式系统的话需要另外考虑使用分布式 ID)。
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 DefaultIdentifierGeneratorFactoryimplements MutableIdentifierGeneratorFactory, Serializable,ServiceRegistryAwareService {
@SuppressWarnings("deprecation")public DefaultIdentifierGeneratorFactory() {register( "uuid2", UUIDGenerator.class );register( "guid", GUIDGenerator.class ); // can be done with UUIDGenerator + strategyregister( "uuid", UUIDHexGenerator.class ); // "deprecated" for new useregister( "uuid.hex", UUID
HexGenerator.class ); // uuid.hex is deprecatedregister( "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() );}}}
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;
4.指定不持久化特定字段
@Transient
:声明不需要与数据库映射的字段,在保存的时候不需要保存进数据库 。
如果我们想让 secrect
这个字段不被持久化,可以使用 @Transient
关键字声明。
Entity(name="USER")public class User {
......@Transientprivate 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 transient
一般使用注解的方式比较多。
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;
6.创建枚举类型的字段
可以使用枚举类型的字段,不过枚举字段要用 @Enumerated
注解修饰。
public enum Gender {MALE("男性"),FEMALE("女性");
private String value;Gender(String str){value=str;}}
@Entity @Table(name = "role")public class Role {@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;private String name;private String description;@Enumerated(EnumType.STRING)private Gender gender;省略 getter/setter......}
数据库里面对应存储的是 MAIL/FEMAIL。
7.增加审计功能
只要继承了 AbstractAuditBase
的类都会默认加上下面四个字段。
@Data@AllArgsConstructor@NoArgsConstructor@MappedSuperclass@EntityListeners(value = AuditingEntityListener.class)public abstract class AbstractAuditBase {@CreatedDate@Column(updatable = false)@JsonIgnoreprivate Instant createdAt;
@LastModifiedDate@JsonIgnoreprivate Instant updatedAt;
@CreatedBy@Column(updatable = false)@JsonIgnoreprivate String createdBy;
@LastModifiedBy@JsonIgnoreprivate String updatedBy;}
我们对应的审计功能对应地配置类可能是下面这样的(Spring Security 项目):
@Configuration@EnableJpaAuditingpublic class AuditSecurityConfiguration {@BeanAuditorAware<String> auditorAware() {return () -> Optional.ofNullable(SecurityContextHolder.getContext()).map(SecurityContext::getAuthentication).filter(Authentication::isAuthenticated).map(Authentication::getName); } }
简单介绍一下上面设计到的一些注解:
@CreatedDate
: 表示该字段为创建时间时间字段,在这个实体被 insert 的时候,会设置值@CreatedBy
:表示该字段为创建人,在这个实体被 insert 的时候,会设置值@LastModifiedDate
、@LastModifiedBy
同理。
@EnableJpaAuditing
:开启 JPA 审计功能。
8.删除/修改数据
@Modifying
注解提示 JPA 该操作是修改操作,注意还要配合 @Transactional
注解使用。
@Repositorypublic interface UserRepository extends JpaRepository<User, Integer> {@Modifying@Transactional(rollbackFor = Exception.class)void deleteByUserName(String userName);}
9.关联关系
@OneToOne
声明一对一关系@OneToMany
声明一对多关系@ManyToOne
声明多对一关系MangToMang
声明多对多关系
九、事务 @Transactional
在要开启事务的方法上使用 @Transactional
注解即可!
@Transactional(rollbackFor = Exception.class)public void save() {......}
我们知道 Exception 分为运行时异常 RuntimeException 和非运行时异常。在 @Transactional
注解中如果不配置 rollbackFor
属性,那么事物只会在遇到 RuntimeException
的时候才会回滚,加上rollbackFor=Exception.class
,可以让事物在遇到非运行时异常时也回滚。
@Transactional
注解一般用在可以作用在 类
或者 方法
上。
作用于类:当把
@Transactional
注解放在类上时,表示所有该类的 public 方法都配置相同的事务属性信息。作用于方法
:当类配置了@Transactional
,方法也配置了@Transactional
,方法的事务会覆盖类的事务配置信息。
十、json 数据处理
1.过滤 json 数据
@JsonIgnoreProperties
作用在类上用于过滤掉特定字段不返回或者不解析。
//生成 json 时将 userRoles 属性过滤 @JsonIgnoreProperties({"userRoles"})public class User {
private String userName;private String fullName;private String password;@JsonIgnoreprivate List<UserRole> userRoles = new ArrayList<>();}
@JsonIgnore
一般用于类的属性上,作用和上面的 @JsonIgnoreProperties
一样。
public class User {
private String userName;private String fullName;private String password;//生成 json 时将 userRoles 属性过滤 @JsonIgnoreprivate List<UserRole> userRoles = new ArrayList<>();}
2.格式化 json 数据
@JsonFormat
一般用来格式化 json 数据:
比如:
@JsonFormat(shape=JsonFormat.Shape.STRING, pattern="yyyy-MM- dd'T'HH:mm:ss.SSS'Z'", timezone="GMT")private Date date;
3.扁平化对象
@Getter@Setter@ToStringpublic class Account {@JsonUnwrappedprivate Location location;@JsonUnwrappedprivate PersonInfo personInfo;
@Getter@Setter@ToStringpublic static class Location {private String provinceName;private String countyName;}@Getter@Setter@ToStringpublic static class PersonInfo {private String userName;private String fullName;}}
未扁平化之前:
{"location": {"provinceName":"湖南","countyName":"长沙"},"personInfo": {"userName": "1111","fullName": "Caiyo"}}
使用 @JsonUnwrapped
扁平对象之后:
@Getter@Setter@ToStringpublic class Account {@JsonUnwrappedprivate Location location;@JsonUnwrappedprivate PersonInfo personInfo;......}
{"provinceName":"湖南","countyName":"长沙","userName": "1111","fullName": "Caiyo"}
十一、测试相关
@ActiveProfiles
一般作用于测试类上, 用于声明生效的 Spring 配置文件。
@SpringBootTest(webEnvironment = RANDOM_PORT)@ActiveProfiles("test")@Slf4jpublic abstract class TestBase {......}
@Test
声明一个方法为测试方法
@Transactional
被声明的测试方法的数据会回滚,避免污染测试数据。
@WithMockUser Spring Security
提供的,用来模拟一个真实用户,并且可以赋予权限。
@Test@Transactional@WithMockUser(username = "user-id-18163138155", authorities = "ROLE_TEACHER")void should_import_student_success() throws Exception {......}
参考资料:《Java 中高级核心知识全面解析》获取方式:私信【资料】免费获取
评论