MybatisPlus欄位型別轉換的實現範例

2023-11-03 18:00:15

resultMap的作用是什麼

在使用傳統的mybatis時，我們一般都會在xml檔案定義一個ResultMap

對每個欄位都有自己的定義都有兩個型別
javaType可以不顯式寫出來，mybatis可以根據指定的實體類推斷出來
jdbcType 也就是對應到資料庫中的欄位型別
mybatis完成資料庫的資料到java實體型別的轉換這兩個型別是必不可少的。會根據javaType和jdbcType去匹配到對應的處理器完成型別轉換
mybatis內建了很多typeHandler在啟動時註冊

public TypeHandlerRegistry(Configuration configuration) {
    this.unknownTypeHandler = new UnknownTypeHandler(configuration);

    register(Boolean.class, new BooleanTypeHandler());
    register(boolean.class, new BooleanTypeHandler());
    register(JdbcType.BOOLEAN, new BooleanTypeHandler());
    register(JdbcType.BIT, new BooleanTypeHandler());

    register(Byte.class, new ByteTypeHandler());
    register(byte.class, new ByteTypeHandler());
    register(JdbcType.TINYINT, new ByteTypeHandler());

    register(Short.class, new ShortTypeHandler());
    register(short.class, new ShortTypeHandler());
    register(JdbcType.SMALLINT, new ShortTypeHandler());

    register(Integer.class, new IntegerTypeHandler());
    register(int.class, new IntegerTypeHandler());
    register(JdbcType.INTEGER, new IntegerTypeHandler());

    register(Long.class, new LongTypeHandler());
    register(long.class, new LongTypeHandler());

    register(Float.class, new FloatTypeHandler());
    register(float.class, new FloatTypeHandler());
    register(JdbcType.FLOAT, new FloatTypeHandler());

    register(Double.class, new DoubleTypeHandler());
    register(double.class, new DoubleTypeHandler());
    register(JdbcType.DOUBLE, new DoubleTypeHandler());

    register(Reader.class, new ClobReaderTypeHandler());
    register(String.class, new StringTypeHandler());
    register(String.class, JdbcType.CHAR, new StringTypeHandler());
    register(String.class, JdbcType.CLOB, new ClobTypeHandler());
    register(String.class, JdbcType.VARCHAR, new StringTypeHandler());
    register(String.class, JdbcType.LONGVARCHAR, new StringTypeHandler());
    register(String.class, JdbcType.NVARCHAR, new NStringTypeHandler());
    register(String.class, JdbcType.NCHAR, new NStringTypeHandler());
    register(String.class, JdbcType.NCLOB, new NClobTypeHandler());
    register(JdbcType.CHAR, new StringTypeHandler());
    register(JdbcType.VARCHAR, new StringTypeHandler());
    register(JdbcType.CLOB, new ClobTypeHandler());
    register(JdbcType.LONGVARCHAR, new StringTypeHandler());
    register(JdbcType.NVARCHAR, new NStringTypeHandler());
    register(JdbcType.NCHAR, new NStringTypeHandler());
    register(JdbcType.NCLOB, new NClobTypeHandler());

    register(Object.class, JdbcType.ARRAY, new ArrayTypeHandler());
    register(JdbcType.ARRAY, new ArrayTypeHandler());

    register(BigInteger.class, new BigIntegerTypeHandler());
    register(JdbcType.BIGINT, new LongTypeHandler());

    register(BigDecimal.class, new BigDecimalTypeHandler());
    register(JdbcType.REAL, new BigDecimalTypeHandler());
    register(JdbcType.DECIMAL, new BigDecimalTypeHandler());
    register(JdbcType.NUMERIC, new BigDecimalTypeHandler());

    register(InputStream.class, new BlobInputStreamTypeHandler());
    register(Byte[].class, new ByteObjectArrayTypeHandler());
    register(Byte[].class, JdbcType.BLOB, new BlobByteObjectArrayTypeHandler());
    register(Byte[].class, JdbcType.LONGVARBINARY, new BlobByteObjectArrayTypeHandler());
    register(byte[].class, new ByteArrayTypeHandler());
    register(byte[].class, JdbcType.BLOB, new BlobTypeHandler());
    register(byte[].class, JdbcType.LONGVARBINARY, new BlobTypeHandler());
    register(JdbcType.LONGVARBINARY, new BlobTypeHandler());
    register(JdbcType.BLOB, new BlobTypeHandler());

    register(Object.class, unknownTypeHandler);
    register(Object.class, JdbcType.OTHER, unknownTypeHandler);
    register(JdbcType.OTHER, unknownTypeHandler);

    register(Date.class, new DateTypeHandler());
    register(Date.class, JdbcType.DATE, new DateOnlyTypeHandler());
    register(Date.class, JdbcType.TIME, new TimeOnlyTypeHandler());
    register(JdbcType.TIMESTAMP, new DateTypeHandler());
    register(JdbcType.DATE, new DateOnlyTypeHandler());
    register(JdbcType.TIME, new TimeOnlyTypeHandler());

    register(java.sql.Date.class, new SqlDateTypeHandler());
    register(java.sql.Time.class, new SqlTimeTypeHandler());
    register(java.sql.Timestamp.class, new SqlTimestampTypeHandler());

    register(String.class, JdbcType.SQLXML, new SqlxmlTypeHandler());

    register(Instant.class, new InstantTypeHandler());
    register(LocalDateTime.class, new LocalDateTimeTypeHandler());
    register(LocalDate.class, new LocalDateTypeHandler());
    register(LocalTime.class, new LocalTimeTypeHandler());
    register(OffsetDateTime.class, new OffsetDateTimeTypeHandler());
    register(OffsetTime.class, new OffsetTimeTypeHandler());
    register(ZonedDateTime.class, new ZonedDateTimeTypeHandler());
    register(Month.class, new MonthTypeHandler());
    register(Year.class, new YearTypeHandler());
    register(YearMonth.class, new YearMonthTypeHandler());
    register(JapaneseDate.class, new JapaneseDateTypeHandler());

    // issue #273
    register(Character.class, new CharacterTypeHandler());
    register(char.class, new CharacterTypeHandler());
  }

當然我們不指定型別的話mybatis也具備自動推斷型別的能力。
org.apache.ibatis.executor.resultset.DefaultResultSetHandler#createAutomaticMappings
建立自動的欄位對映根據資料庫查詢結果型別，和我們指定的物件欄位型別做對映

mybatisPlus如何完成欄位對映

當然也可以指定resultMap

@TableNam中有resultMap屬性

    /**
     * 實體對映結果集,
     * 只生效與 mp 自動注入的 method
     */
    String resultMap() default "";

@Mapper
public interface UserDoMapper extends BaseMapper<User> {

    @Results(
            id = "userResultMap",
            value = {@Result(column = "id",property = "id",javaType = Integer.class,jdbcType = JdbcType.INTEGER),
                    @Result(column = "user_name",property = "userName",javaType = String.class,jdbcType = JdbcType.VARCHAR),
                    @Result(column = "pass_word",property = "passWord",javaType = String.class,jdbcType = JdbcType.VARCHAR),
                    @Result(column = "real_name",property = "realName",javaType = String.class,jdbcType = JdbcType.VARCHAR),
                    @Result(column = "json_arr",property = "jsonArr",typeHandler = StringToJsonArrayBaseTypeHandler.class),

            }
    )

    @Select("SELECT * FROM user ${ew.customSqlSegment}")
    User searchDetail( @Param(Constants.WRAPPER) Wrapper<User> wrapper);
}

@TableName(resultMap = "userResultMap")
public class User {
    @TableField(jdbcType = JdbcType.INTEGER)
    private Integer id;
    @TableField(jdbcType = JdbcType.VARCHAR)
    private String userName;
    @TableField(jdbcType = JdbcType.VARCHAR)
    private String passWord;
    @TableField(jdbcType = JdbcType.VARCHAR)
    private String realName;
    @TableField(typeHandler = StringToJsonArrayBaseTypeHandler.class)
    private List<String> jsonArr;

}

那麼我們不想手動定義ResutMap但是又想處理一些複雜型別的轉換就可以使用autoResultMap

自動對映

我們在使用mybatisPlus時在大多數情況是不會定義resultMap的，那麼mybatisPlus是如何完成欄位對映的，那麼答案顯而易見，就是使用myabtis的欄位自動建立對映的功能。
自動對映的方案有什麼缺點？
1.對於複雜的型別，無法指定轉換方案，無法使用自定義的型別轉換器。
2.無法使用關聯查詢
開啟autoResultMap

@TableName(autoResultMap = true)

那麼mybatisPlus會根據我們的實體類的型別，為我們自動注入resultMap,注入的resultMap也會自動推斷出需要使用的型別轉換器當然我們也可以指定

例如

   @TableField(typeHandler = StringToJsonArrayBaseTypeHandler.class)
    private List<String> jsonArr;

也因此說，對於查詢來說，mybatisPlus通過@TableField指定型別轉換器，一定要開啟autoResultMap才能生效了。另外mybatisPlus只會為BaseMapper中的方法生成resultMap，而我們自定義的方法，是不會生成的。
例如

@Mapper
public interface UserDoMapper extends BaseMapper<User> {

    @Select("SELECT * FROM user ${ew.customSqlSegment}")
    User searchDetail( @Param(Constants.WRAPPER) Wrapper<User> wrapper);
}

這種寫法autoResultMap和指定的型別轉換器是不會生效的。如果有複雜欄位轉換需求，需要通過@Results標籤定義resultMap
例如

以及通過@ResultMap標籤進行參照

@TableField是能夠指定jdbcType的

不指定jdbcType時mybatis往往也能夠完成自動轉換，例如java中的String自然對應到資料庫的VAERCHAR
在mybatis無法根據自動完成javaType到jdbcType的轉換時，可以使用@TableField註解完成轉換，例如我們想將一個資料庫中的VARCHAR型別對映成為java中的Integer，對於插入操作時又要完成Integer到VARCHAR的轉換，如果不指定jdbcType那麼插入操作將會報錯

   @TableField(jdbcType = JdbcType.VARCHAR)
    private Integer age;

mybatis如何完成查詢引數轉換

前面看的是對於查詢結果的轉換，那麼對於插入，更新，查詢等操作，也有一個javaType到jdbcType的轉換，對於複雜的欄位型別例如集合轉json又是如何生效的？
還是先看傳統mybatis定義對映的寫法

<insert id="insert" parameterType="com.imtech.yasha.sp.common.mapper.dto.sp.ZbLabourBidAuctionList" >
    insert into zb_labour_bid_auction_list (id, uuid, uuid_t, 
                                            creater, create_time, updater, 
                                            update_time, item_d, item_n, 
                                            order_no, list_no, sub_project_name, 
                                            construction_tech, unit, project_quantity, 
                                            unit_price, total, remark, 
                                            supplier_no, supplier_name)
    values (#{id,jdbcType=BIGINT}, #{uuid,jdbcType=VARCHAR}, #{uuidT,jdbcType=VARCHAR}, 
            #{creater,jdbcType=VARCHAR}, #{createTime,jdbcType=TIMESTAMP}, #{updater,jdbcType=VARCHAR}, 
            #{updateTime,jdbcType=TIMESTAMP}, #{itemD,jdbcType=VARCHAR}, #{itemN,jdbcType=VARCHAR}, 
            #{orderNo,jdbcType=VARCHAR}, #{listNo,jdbcType=VARCHAR}, #{subProjectName,jdbcType=VARCHAR}, 
            #{constructionTech,jdbcType=VARCHAR}, #{unit,jdbcType=VARCHAR}, #{projectQuantity,jdbcType=NUMERIC}, 
            #{unitPrice,jdbcType=NUMERIC}, #{total,jdbcType=NUMERIC}, #{remark,jdbcType=VARCHAR}, 
            #{supplierNo,jdbcType=VARCHAR}, #{supplierName,jdbcType=VARCHAR})
    </insert>

在引數上一般都會定義jdbcType，至於JavaType可以從parameterType指定的class中推斷出來，這樣javaTyp和jdbcType都被確定下來，很容易匹配到對應的處理器進行型別轉換。
那麼在mybatisPlus中顯然不會為每個入參欄位定義jdbcType，那麼對於入參是如何進行轉換的，複雜型別又是如何指定的

   @TableField(typeHandler = StringToJsonArrayBaseTypeHandler.class)
    private List<String> jsonArr;

答案也是通過@TableField指定的，而且即使關閉autoResultMap，對於查詢引數的轉換，指定的型別轉換器和jdbcType也是會生效的。

到此這篇關於MybatisPlus欄位型別轉換的實現範例的文章就介紹到這了,更多相關MybatisPlus 欄位型別轉換內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！