Mysql json型別欄位Java+Mybatis資料字典功能的實踐方式

2022-08-25 18:03:32

前言

JSON型別是MySQL5.7.8中新加入的一種資料型別，並在後續版本尤其是MySQL8.0中得到了大幅增強，現在的JSON型別的功能十分強大，合理使用能讓我們的開發更加有效!

但本文不準備花篇幅來介紹MySQL的JSON型別欄位的相關API，因為官方檔案裡面寫得已經十分詳細了，大家如果對MySQL的JSON型別還不怎麼了解的話可以看看官方檔案：

MySQL5.7 JSON功能介紹：https://dev.mysql.com/doc/refman/5.7/en/mysql-nutshell.html (搜 JSON support)
MySQL8.0 JSON增強說明：https://dev.mysql.com/doc/refman/8.0/en/mysql-nutshell.html (搜 JSON enhanc)
MySQL8.0 JSON功能介紹：https://dev.mysql.com/doc/refman/8.0/en/json.html

(ps：英語相對較差的小夥伴可以用chrome瀏覽器開啟，然後用自帶的翻譯工具翻譯後看哦~)

應用場景介紹

JSON的應用場景還是挺多的，我能想到的兩個是：

資料字典

基本上所有系統都會有資料字典，比如各種下拉框的內容，這種資料如果需要支援讓使用者自定義，那麼基本上就是使用資料字典，而字典內容則是標準的JSON物件，用JSON儲存再好不過！

動態表單

如一些資訊收集的表單，需要提供使用者自定義資訊時，這些資訊也是JSON物件，也可以通過JSON欄位儲存。

資料字典案例實踐

本文將針對資料字典使用JSON型別案例進行詳細介紹，本文中使用的ORM框架是Mybatis，其他ORM框架應該也大同小異。如果其他框架使用出現問題，可以留言一起討論哦~
本文中還是用了Swagger、Mybatis Plus、Lombok等工具，如果這些還不熟悉的可以先去做做功課哦，這些都是開發中非常強大而給力的工具，讓我們編碼時如虎添翼，效率翻倍~

功能方面需要明確的是：

列舉選項是嚴禁直接刪除的。

字典內容只能增加不能減少，因為一旦刪除一個選項，會導致擁有這個選項的資料無法找到對應列舉，導致顯示異常。
當然，如果非要有刪除功能，我們也能像表資料那樣增加一個邏輯刪除功能。

列舉選項的鍵是嚴禁修改的。

這個就不用過多解釋了，鍵就相當於表的ID一樣，肯定是不允許修改的，用於展示的值可修改。

可以增加一些輔助功能。

可以對選項增加一個排序功能，讓客戶能自定義排序。
可以增加建立修改資訊欄位，記錄選項改動資訊。

表結構

CREATE TABLE `sys_dict` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `code` varchar(30) NOT NULL COMMENT '編碼',
  `name` varchar(40) NOT NULL COMMENT '展示名稱',
  `content` json NOT NULL COMMENT '內容',
  /* 下面六個欄位根據需要增加 */
  `description` varchar(200) DEFAULT NULL COMMENT '描述',
  `deleted` tinyint(1) NOT NULL DEFAULT '0' COMMENT '是否刪除 [0未刪除 1已刪除]',
  `create_by` int(11) DEFAULT NULL COMMENT '建立人',
  `create_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '建立時間',
  `update_by` int(11) DEFAULT NULL COMMENT '修改人',
  `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改時間',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='系統字典表';

實體類

@Getter
@Setter
@TableName(value = "sys_dict", autoResultMap = true)
@ApiModel("系統字典實體類")
public class SysDict extends BaseDO {

    @TableId(type = IdType.AUTO) //id自增
    private Integer id;

    @ApiModelProperty("編碼")
    private String code;

    @ApiModelProperty("名稱")
    private String name;

    @TableField(typeHandler = JacksonTypeHandler.class)
    @ApiModelProperty("內容列表")
    private List<DictContent> content;

    @Getter
    @Setter
    @NoArgsConstructor
    @ApiModel("系統字典內容實體類")
    public static class DictContent {

        @ApiModelProperty("鍵")
        private Integer key;

        @ApiModelProperty("值")
        private String value;

        @ApiModelProperty("排序，數位越小越前面")
        private Integer order;

	    @ApiModelProperty("是否刪除 [0:未刪除 1:已刪除]")
	    private Integer deleted;
		
		//輔助欄位根據需求來定，有必要的情況下可以繼承BaseDO，增加那6個欄位！
    }
}


@Getter
@Setter
public abstract class BaseDO implements Serializable {

    @ApiModelProperty("備註")
    private String description;

    @ApiModelProperty("是否刪除 [0:未刪除 1:已刪除]")
    private Integer deleted;

    @ApiModelProperty("建立人")
    private Integer createBy;

	//JSONFormat是格式化時間的輸入輸出格式
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", locale = "zh", timezone = "GMT+8")
    @ApiModelProperty("建立時間")
    private LocalDateTime createTime;

    @ApiModelProperty("修改人")
    private Integer updateBy;

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", locale = "zh", timezone = "GMT+8")
    @ApiModelProperty("修改時間")
    private LocalDateTime updateTime;

}

這裡為了方便，將建立修改資訊等6個欄位抽象出來了，以後建立實體類就直接繼承該類就行，同時該類宣告了序列化，所以其子類也不需要再單獨實現Serializable介面，一舉多得~

這裡有兩個個細節：

將BaseDO類宣告成抽象類：如果不宣告成抽象類的話，在絲襪哥(Swagger)介面檔案中就只會顯示父類別BaseDO的資訊，不會顯示其子類資訊。(我之前就是沒有宣告成抽象類，出現了這個問題，糾結了一陣。。。)
將內部類DictContent用static修飾：如果用static修飾的話，其他地方就無法直接使用該類的構造方法；在查詢資料時，Mybatis就無法範例化該物件，會報錯的哦。

關係對映

通過Mybatis Plus註解實現

上文中的@TableName和@TableField是Mybatis Plus提供的註解，@TableName的autoResultMap屬性一般與content欄位的@TableField的typeHandler屬性一起使用，表示會自動建立resultMap處理查詢返回值，但這個操作僅限於Mybatis Plus提供的查詢方法，自定義方法不會自動建立。

通過ResultMap實現

需要注意的是：如果你在對應的Mapper檔案中自定義了型別為這個實體類的ResultMap的話，上述操作也不會執行。也就是說如果需要自定義ResultMap，則需要手動增加typeHandler屬性：

沒有使用Mybatis Plus的小夥伴也是通過下述這種方式進行型別轉換~~

<!-- 通用查詢對映結果 -->
<resultMap id="BaseResultMap" type="com.copm.ifm.servers.insp.entity.SysDict">
    <id column="id" property="id" />
    <result column="code" property="code" />
    <result column="name" property="name" />
    <!-- 這裡顯示指定typeHandler屬性值 -->
    <result column="content" property="content" 
    		jdbcType="JAVA_OBJECT" javaType="java.util.List"
            typeHandler="com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler"/>
    <result column="description" property="description" />
    <result column="deleted" property="deleted" />
    <result column="create_by" property="createBy" />
    <result column="create_time" property="createTime" />
    <result column="update_by" property="updateBy" />
    <result column="update_time" property="updateTime" />
</resultMap>

上述程式碼中使用的jdbcType="JAVA_OBJECT"中，jdbcType的取值範圍來源於org.apache.ibatis.type.JdbcType列舉。

content的javaType不要寫成了SysDict#DictContent 哦！他的java型別是List，DictContent是List的泛型。

只要存在type=“com.copm.ifm.servers.insp.entity.SysDict” 的resultMap，就會使Mybatis Plus的 @TableName(autoResultMap = true) 失效。