@JsonView的使用(使用自己的封装结果类)

1.项目使用了springboot + mybatis-plus,在开发时需要指定封装需要的数据,但是由于使用了自定义的结果封装类,输出的结果为空

  1. 在项目中统一抽取了一个BaseEntity,这里封装应用所有实体共同的属性,因此在这里抽取了一个BaseEntityView
@Getter
@Setter
public class BaseEntity implements Serializable {

    /**
     * 主键id
     */
    @TableId(value = "ID", type = IdType.ASSIGN_UUID)
    @ApiModelProperty(value = "主键id")
    @JsonView(BaseEntityView.class)
    private String id;

    /**
     * 创建时间
     */
    @TableField(value = "CREATE_TIME", fill = FieldFill.INSERT, insertStrategy = FieldStrategy.NOT_EMPTY)
    @ApiModelProperty(value = "创建时间,格式:yyyy-MM-dd HH:mm:ss", dataType = "Date", example = "2020-05-05 10:10:10")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonView(BaseEntityView.class)
    private Date createTime;

    /**
     * 修改时间
     */
    @TableField(value = "MODIFY_TIME", fill = FieldFill.INSERT_UPDATE, updateStrategy = FieldStrategy.NOT_EMPTY)
    @ApiModelProperty(value = "修改时间,格式:yyyy-MM-dd HH:mm:ss", dataType = "Date", example = "2020-05-05 10:10:10")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonView(BaseEntityView.class)
    private Date modifyTime;

    /**
     * 软删除标志:1已删除,0未删除
     */
    @TableLogic
    @ApiModelProperty(value = "删除标志(软删除:1已删除,0未删除)", dataType = "Integer")
    @TableField(value = "DELETED")
    @JsonView(BaseEntityView.class)
    private DeletedEnum deleted = DeletedEnum.UNDELETED;


    /**
     * 基础的视图展示,都提供id,展示都需要继承这个接口
     */
    public interface BaseEntityView {
    }

}

  1. 当每个entity需要实现展示自定义的字段时
@Data
public class Entity extends BaseEntity {

    private static final long serialVersionUID = 1L;

    @JsonView(PlatformAppSimpleView.class)
    private AppStatusEnum status;


    @JsonView(PlatformAppSimpleView.class)
    private String name;

    @JsonView(PlatformAppSimpleView.class)
    private String key;


    @JsonView(PlatformAppSimpleView.class)
    private String secret;

    /**
     * 定义页面上视图展示的数据,用于列表展示
     */
    public interface PlatformAppSimpleView extends BaseEntityView {
    }


    /**
     * 视图的详细定义,用于编辑
     */
    public interface PlatformAppDetailsView extends PlatformAppSimpleView {
    }

}

4.controller层数据展示


    @PostMapping(
            produces = "application/json;charset=utf-8",
            consumes = "application/json;charset=utf-8"
    )
    @JsonView(PlatformApp.PlatformAppSimpleView.class)
    public ResultWrapper<PageDto<?>> page(@RequestBody PageDto<?> page) {
        return new ResultWrapper<>(platformAppService.page(page));
    }

5.重点,由于我将数据封装了两层,所有每层需要展示的数据都要使用注解,这个时候统一抽取出来的BaseEntityView就有用了

@Data
@AllArgsConstructor
public class ResultWrapper<T> {

    /**
     * 错误码,其中 {@code 0} 代表没有错误
     *
     * <p>详见 {@link ErrorCode}</p>
     */
    @JsonView(BaseEntity.BaseEntityView.class)
    private int errorCode;

    /**
     * 错误或成功的描述信息
     */
    @JsonView(BaseEntity.BaseEntityView.class)
    private String message;

    /**
     * 具体业务的返回结果
     */
    @JsonView(BaseEntity.BaseEntityView.class)
    private T result;

    /**
     * 操作成功(设置默认成功的错误码和描述信息),只需设置具体业务的返回结果
     *
     * @param result 具体业务的返回结果
     */
    public ResultWrapper(T result) {
        errorCode = ErrorCode.SUCCESS.getErrorCode();
        message = ErrorCode.SUCCESS.getMessage();
        this.result = result;
    }

    /**
     * 只设置错误码和描述信息,不需要具体业务的返回结果
     *
     * @param errorCode 错误码,详见 {@link ErrorCode}
     * @param message   错误或成功的描述信息
     */
    public ResultWrapper(ErrorCode errorCode, String message) {
        this.errorCode = errorCode.getErrorCode();
        this.message = message;
    }
}

6.同时,还有一层封装的数据

@Data
public class PageDto<T> implements IPage<T> {

   /**
     * 查询数据列表,实际数据封装的位置,这里很重要
     */
    @JsonView(BaseEntity.BaseEntityView.class)
    private List<T> records = Collections.emptyList();

    private long total = 0;

    private long size = 10;

    private long current = 1;

    private long pages;

    private boolean isSearchCount = true;

    private boolean isPageable = true;

    private List<OrderItem> orders = new ArrayList<>();


    @Override
    public List<OrderItem> orders() {
        return this.getOrders();
    }

}

参考:https://yq.aliyun.com/articles/713458

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,110评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,443评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,474评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,881评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,902评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,698评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,418评论 3 419
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,332评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,796评论 1 316
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,968评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,110评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,792评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,455评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,003评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,130评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,348评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,047评论 2 355