当前位置： 首页>后端>正文

JavaGuide知识点整理——spring&springboot常用注解总结

后端2024-04-20 12:08:02

@SpringBootApplication

这个注解其实我们常见但是又不怎么主动使用。这个注解是spring boot项目的基石。会默认在启动类上加上。其实我们可以把这个注解看成是多个注解的集合：


JavaGuide知识点整理——spring&springboot常用注解总结,第1张
SpringBootApplication注解源码

其中主要的三个注解是：

  • @SpringBootConfiguration:它的底层其实是@Configuration.允许在Spring上下文中注册额外的bean或者导入其它配置类。


    JavaGuide知识点整理——spring&springboot常用注解总结,第2张
    @SpringBootConfiguration
  • @ComponentScan:扫描被@Component，@Repository,@Service,@Controller注解的bean，注解默认会扫描该类所在的包下的所有的类(这也是boot项目启动类必须在最外层的原因)
  • @EnableAutoConfiguration:启动SpringBoot的自动配置机制。

Spring Bean相关

@Autowired

自动导入对象到类中，被注入进的类同样要被spring容器管理。比如Service类注入到Controller类中。

@Component，@Repository，@Service，@Controller

我们一般使用@Autowired注解让Spring容器帮我们自动装配bean。要想要类标识成可用于@Autowired注解自动装配的bean的类，可以采用以下注解实现：

  • @Component:通用的注解，可标注任意类为Spring组件。如果一个bean不知道属于哪层，可以使用这个注解来标注。
  • @Repository:对应持久层即Dao层，主要用于数据库相关操作。
  • @Service:对应服务层，主要涉及一些复杂的逻辑，需要用到Dao层。
  • @Controller:对应Spring MVC控制层。主要用于接受用户请求并调用Service层返回数据给前端页面。

@RestController

@RestController注解是@Controller和@ResponseBody的合集。表示这是个控制器bean，并且将函数的返回值直接填入http响应体中。是REST风格的控制器。
单独使用@Controller不加@ResponseBody的话，一般是用在要返回一个视图的情况。如果加了@ResponseBody返回的是JSON或者XML形式的数据。

@Scope

这个是声明Spring Bean的作用域，使用方法就是指定作用域。这个注解有四种常见的作用域：

  • singleton:唯一bean实例。Spring中的bean默认都是单例的
  • prototype:每次请求都会创建一个新的bean实例
  • request:每一个HTTP请求都会产生一个新的bean，该bean仅在当前http的request中有效。
  • session:每一个http session会产生一个新的bean。该bean仅在当前http session下有效。

下面的简单的例子：


JavaGuide知识点整理——spring&springboot常用注解总结,第3张
非单例

JavaGuide知识点整理——spring&springboot常用注解总结,第4张
单例

@Configuration

一般用来声明配置类，可以使用注解@Component注解替代。不过使用@Configuration注解声明配置类更加语义化。

处理常见的http请求类型

5中常见的请求类型(其实就前两个常见，三四个也还行。第五个没用过。 )

  • GET:请求从服务器获取特定资源。
  • POST:在服务器上创建一个新的资源
  • PUT:更新服务器上的资源
  • DELETE:从服务器删除特定的资源
  • PATCH：更新服务器上的资源。

GET请求

@GetMapper("/xxx") 等价于
@RequestMapper(value= "/xxx",method=RequestMethod.GET)

POST请求

@PostMapping("/xxx") 等价于@RequestMapping(value="/xxx",method=RequestMethod.POST)

PUT请求

@PutMapping("/xxx/{userId}") 等价于@RequestMapping(value="/xxx/{userId}",method=RequestMethod.PUT)

DELETE请求

@DeleteMapping("/xxx/{userId}")等价于@RequestMapping(value="/xxx/{userId}",method=RequestMethod.DELETE)

PATCH请求

一般我们很少使用的这个请求，都是put不够用了才会使用。
@PatchMapping("/xx")等价于
@RequestMapping(value = "/xxx",method = RequestMethod.PATCH)

前后端传值

@PathVariable 和@RequestParam

@PathVariable用于获取路径参数
@RequestParam用户就获取查询参数
这两者我们可以同时使用。如下例子：

    @GetMapping("/test/{name}")
    public String test(@PathVariable("name")String name,@RequestParam("id") String id){
        return "id = "+ id +",name = " + name ;
    }
JavaGuide知识点整理——spring&springboot常用注解总结,第5张
运行结果

@RequestBody

用于读取Requst请求的body部分，并且Content-Type是application/json格式的参数。接收到数据之后会自动将数据绑定到java对象上去。系统会使用HttpMessageConyerter或者自定义的HttpMessageConyerter将请求的body中的json字符串转换为java对象。
需要注意一个请求方法里只能有一个@RequestBody，但是可以有多个@RequestParam和@PathVariable.

读取配置信息

很多时候我们需要将一些常用的配置信息比如阿里云oss，发送短信，微信认证的相关配置信息等等放到配置文件中。下面我们来看一下spring为我们提供了哪些方式从配置文件中读取配置信息。

@Value

这个是比较常用的读取配置信息注解，使用方法是@Value("${xxx}")

@ConfigurationProperties

通过@ConfigurationProperties读取配置信息并且与bean绑定。如下demo：


JavaGuide知识点整理——spring&springboot常用注解总结,第6张
@ConfigurationProperties

@PropertySource

这个是读取指定位置的配置文件，然后用@Value注解注入。
怎么说呢，我是觉得这个挺鸡肋的。也可能是我没遇到适用的场景。比如说A,B两个文件中都有url属性。如果我们直接用@Value注入的话是要aplication.yml/properties文件。但是我们可以在类上指定要读取的配置文件，然后用@Value注入。

全局处理Controller层异常

  1. @ControllerAdvice:注解定义全局异常处理类
  2. @ExceptionHandler:注解声明异常处理方法

这个使用不难，但是挺墨迹的，我就不整理了，感兴趣的自己百度吧。

JPA相关

创建表

@Entity声明一个类对应一个数据库实体。
@Table 设置表名

@Entity
@Data
@Table(name = "sys_user")
public class User{
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private Integer age;
}

创建主键

@Id ：声明一个字段为主键。
@GeneratedValue 指定主键生成策略。
jpa中常见的有四种主键生产策略。默认是auto

public enum GenerationType {

    /**
     * 使用一个特定的数据库表格来保存主键
     * 持久化引擎通过关系数据库的一张特定的表格来生成主键,
     */
    TABLE,

    /**
     *在某些数据库中,不支持主键自增长,比如Oracle、PostgreSQL其提供了一种叫做"序列(sequence)"的机制生成主键
     */
    SEQUENCE,

    /**
     * 主键自增长
     */
    IDENTITY,

    /**
     *把主键生成策略交给持久化引擎(persistence engine),
     *持久化引擎会根据数据库在以上三种主键生成 策略中选择其中一种
     */
    AUTO
}

设置字段类型

@Column 声明字段。
可以设置数据库的字段名。也可以设置非空，长度等。还可以添加默认值。比如下面两个demo:

@Column(name = "user_name", nullable = false, length=32)
private String userName;
@Column(columnDefinition = "tinyint(1) default 1")
private Boolean enabled;

指定不持久化特定字段

@Transient ：声明不需要与数据库映射的字段，在保存的时候不需要保存进数据库 。
其实这个mybatis也有类似的功能。就是当实体和数据库表有出入的时候可以用。

声明大字段

@Lob:声明某个字段为大字段。

创建枚举类型的字段

这个实用性还蛮高的。比如传入的男性，女性.然后枚举值定义男性是male，女性是female这种。就是使用比较麻烦，需要自己写枚举类。

public enum Gender {
    MALE("男性"),
    FEMALE("女性");

    private String value;
    Gender(String str){
        value=str;
    }
}

@Entity
@Data
@Table(name = "sys_user")
public class Role {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    @Enumerated(EnumType.STRING)
    private Gender gender;
}

增加审计功能

这个功能其实就是自动给创建人，创建时间，修改人，修改时间赋值。实现如下：
只要继承了AbstractAuditBase的类都会默认加上这四个字段。这里的几个注解都比较见名知意，我就不多解释了。

@Data
@AllArgsConstructor
@NoArgsConstructor
@MappedSuperclass
@EntityListeners(value = AuditingEntityListener.class)
public abstract class AbstractAuditBase {

    @CreatedDate
    @Column(updatable = false)
    @JsonIgnore
    private Instant createdAt;

    @LastModifiedDate
    @JsonIgnore
    private Instant updatedAt;

    @CreatedBy
    @Column(updatable = false)
    @JsonIgnore
    private String createdBy;

    @LastModifiedBy
    @JsonIgnore
    private String updatedBy;
}

然后需要实现一个auditorAware的接口，用处就是为了返回当前的操作人。

@Configuration
@EnableJpaAuditing
public class AuditSecurityConfiguration {
    @Bean
    AuditorAware<String> auditorAware() {
        return request.getSession().getAttribute("username");
    }
}

然后我们在启动类上添加注解@EnableJpaAuditing，开启 JPA 审计功能。

删除/修改数据

@Repository
public interface UserRepository extends JpaRepository<User, Integer> {

    @Modifying
    @Transactional(rollbackFor = Exception.class)
    void deleteByUserName(String userName);
}

关联关系

虽然jpa支持一对一，一对多，多对多等。但是实际上项目中不推荐这么使用，所以我就不多介绍了。反正jpa是支持的，感兴趣的自己去看官网。

事务@Transactional

关于spring事务，我之前有篇文章整理过，感兴趣的可以自己去看看。https://www.jianshu.com/p/78ef931a4674

json数据处理

过滤json数据

@JsonIgnoreProperties 作用在类上用于过滤掉特定字段不返回或者不解析

//生成json时将userRoles属性过滤
@JsonIgnoreProperties({"userRoles"})
public class User {

    private String userName;
    private String fullName;
    private String password;
    private List<UserRole> userRoles = new ArrayList<>();
}

@JsonIgnore作用于属性上和@JsonIgnoreProperties是一样的。

public class User {

    private String userName;
    private String fullName;
    private String password;
   //生成json时将userRoles属性过滤
    @JsonIgnore
    private List<UserRole> userRoles = new ArrayList<>();
}

格式化json数据

@JsonFormat一般用来格式化 json 数据。
比如我们可以把日期用字符串接收

@JsonFormat(shape=JsonFormat.Shape.STRING, pattern="yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", timezone="GMT")
private Date date;

扁平化对象

其实所谓的扁平化我们可以理解成从子对象中取出来放在外层。


JavaGuide知识点整理——spring&amp;springboot常用注解总结,第7张
demo1

上面这段代码执行结果是这样的：

{
    "userEntity": {
        "id": null,
        "name": "lsj",
        "age": 12,
        "level": 1,
        "flag": true,
        "email": "11@qq.com"
    }
}

而如果我们在属性上添加注解：@JsonUnwrapped。


JavaGuide知识点整理——spring&amp;springboot常用注解总结,第8张
demo2

执行结果变成这样：

{
    "id": null,
    "name": "lsj",
    "age": 12,
    "level": 1,
    "flag": true,
    "email": "11@qq.com"
}

测试相关

@SpringBootTest(webEnvironment = RANDOM_PORT) 声明是测试
@ActiveProfiles("test") 指定运行环境是test，用于读取spring配置文件/
@Test 声明一个方法为测试方法
@Transactional被声明的测试方法的数据会回滚，避免污染测试数据。
@WithMockUser Spring Security 提供的，用来模拟一个真实用户，并且可以赋予权限。

本篇笔记就记到这里，真正做的时候才发现spring注解之多真的很难整理清楚，从一开始的兴致勃勃到后来无从下手。不过还算是有个心得：当你需要什么功能的时候不妨先去百度找找，大部分spring 全家桶已经提供轮子了。哪怕spring不提供，也很大几率有现成的轮子。本篇笔记就记到这里，如果稍微帮到你了记得点个喜欢点个关注，也祝大家工作顺顺利利！


https://www.xamrdz.com/backend/3cd1923532.html

相关文章：