【SpringBoot】接口返回值结构与实体类结构不一致的场景

背景

上周参与了一个新项目,刚进来就给了一个新需求,两周上线。我主要是负责编写Java后端。在写的时候发现有一些场景里,前端用到的数据和表里的数据不太一样,有时候要多一些字段,有时候要少一些字段。在此结合我遇到的实际场景,将用到的知识点记录下来。

场景一:Jackson注解------@JsonIgnore

某个接口会返回用户信息,但是我不希望一些敏感信息返回给前端,比如用户的密码。这个时候可以在class的密码字段上添加@JsonIgnore,表示在接口返回的时候不返回该字段。

java 复制代码
public class User{
    @JsonIgnore
	String password;
	// ...
}

场景二:Jackson注解------@JsonUnwrapped

某个接口需要把这个用户信息再封装一层,封装一个所属学校的信息,一起返回回来。这个信息需要在另一个表查出来。这个时候我不可能重新定义一个类把用户的字段又写一遍。这个类和用户类相比,就多了一个学校字段。我的做法就是用继承extends,把用户类继承到这个类上。

但是这样又会遇到一个问题,在返回的时候会返回一个嵌套的对象。而前端希望的是就返回一个对象,不包含其他嵌套对象。这个时候就可以用@JsonUnwrapped添加到用户类字段上,这样就可以实现把字段解耦出来,和学校信息放在同一级的对象字段里,而不是嵌套的对象里。

java 复制代码
public class NewUser extends User {
    String schoolName;
    @JsonUnwrapped
	User user;
}

场景三:Jackson注解------@JsonRawValue

某个接口的某个字段是Json字符串,这样直接返回的话,前端不好取值。这里就用到@JsonRawValue,在接口返回的时候可以自动转成Object对象。

java 复制代码
public class Ob {
	@JsonRawValue
    String jsonString;
}

这里提一句,Jackson本身也有提供ObjectMapper类,可以用来将json对象和String之间的相互转化。

ObjectMapper是Jackson提供的一个类。我主要用到了两个方法:readValue, writeValueAsString

  • readValue用于将json -> Object
  • writeValueAsString用于将Object -> json

场景四:@TableField(exist=False)

这个注解用来传输数据库里没有的、我想临时加上去的字段。

比如之前在写七牛云的项目的时候,存储到七牛云中的资源会有一个名称,这个名称是保存在类里的。如果要访问这个资源,需要先利用七牛云api根据名称构建url,返回这个url给前端,前端才能访问。但问题是,这个构建的这个过程会有时间信息(好像是过一段时间就会失效)。这样就只能在每次请求接口的时候,构建一次url,放到类中,最后返回给前端。

这里就要用到这个字段

java 复制代码
public class Resource {
    String name; // 名称
    @TableField(exist=False)
    String url; // 资源链接
    public void setUrl(String url) {
		this.url = url;
	}
}
相关推荐
程序员张31 小时前
Maven编译和打包插件
java·spring boot·maven
灵犀学长2 小时前
EasyExcel之SheetWriteHandler:解锁Excel写入的高阶玩法
spring boot·excel
zwjapple3 小时前
docker-compose一键部署全栈项目。springboot后端,react前端
前端·spring boot·docker
tan180°5 小时前
MySQL表的操作(3)
linux·数据库·c++·vscode·后端·mysql
DuelCode6 小时前
Windows VMWare Centos Docker部署Springboot 应用实现文件上传返回文件http链接
java·spring boot·mysql·nginx·docker·centos·mybatis
优创学社26 小时前
基于springboot的社区生鲜团购系统
java·spring boot·后端
why技术6 小时前
Stack Overflow,轰然倒下!
前端·人工智能·后端
幽络源小助理6 小时前
SpringBoot基于Mysql的商业辅助决策系统设计与实现
java·vue.js·spring boot·后端·mysql·spring
猴哥源码6 小时前
基于Java+springboot 的车险理赔信息管理系统
java·spring boot
ai小鬼头7 小时前
AIStarter如何助力用户与创作者?Stable Diffusion一键管理教程!
后端·架构·github