@TableName、@TableId、@TableField、MyBatis-Plus フィールド タイプ プロセッサ TypeHandler

一、 @TableName 、@TableId、@TableField

@TableName(value = "sys_Log")  //value作用：value指定数据库中的表名
public class SysLog {}

@TableId(type=IdType.AUTO)     //声明主键自增长
 private Long id;

@TableField(value = "email")     //通过tableField进行字段不一致的映射, 比如数据库字段是email，而实体类对应的是mail
private String mail;              

@TableField(select = false)        //查询时，则不返回该字段的值

@TableField(exist = false)         //设置该字段在数据库表中不存在

@TablieField(value = "create_time",fill = FieldFill.INSERT)   //插入时自动填充
 private LocalDateTime createTime;

@TablieField(value = "update_time",fill = FieldFill.INSERT_UPDATE)    //更新时自动填充
 private LocalDateTime updateTime;

2. MyBatis-Plus フィールド型プロセッサ TypeHandler

【背景使用】

データベースの型が Java オブジェクトの属性の型に対応しない場合、挿入、更新、クエリ時のデータ型変換の問題はアノテーションによって解決できることが期待されます。

比如说我们Mysql 中的字段类型 为 BigInt，Java程序中的属性类型为 Date，所以我们在入库的时候就是要将
 Date 类型转化为 Long进行入库，在从数据库中取出来的时候，要从 Long 类型转化为 Date 映射到 JavaBean中

[ここにマッピングテーブルを挿入]

MySQLのデータ型	Javaエンティティクラスの属性タイプ	説明する
整数	整数	署名付きか署名なしかに関係なく、Java エンティティ タイプは整数です。
ビギント	長さ	bigint(xxx) 括弧の数に関係なく、署名付きか署名なしかに関係なく、Java エンティティ タイプは Long です。
少し	バイト[]	-
タイニーント	バイト	署名付きか未署名かに関係なく、java.lang パッケージ内の Java エンティティ タイプは Byte です。
smallint	短い	署名付きか未署名かに関係なく、Java エンティティ タイプは Short です。
文字	弦	char が gbk、utf8、utf8mb4 または他のエンコーディング タイプであるかどうかに関係なく、Java エンティティ タイプは String です。
可変長文字	弦	char が gbk、utf8、utf8mb4 または他のエンコーディング タイプであるかどうかに関係なく、Java エンティティ タイプは String です。
ロングバーチャー	弦	char が gbk、utf8、utf8mb4 または他のエンコーディング タイプであるかどうかに関係なく、Java エンティティ タイプは String です。
日付	日付	java.util.Date
日付時刻	日付	java.util.Date
タイムスタンプ	日付	java.util.Date
時間	日付	java.util.Date
浮く	浮く	署名付きか未署名かに関係なく、Java エンティティ タイプは Float です。
10進数	長さ	-
数値	長さ	-
ダブル	ダブル	署名付きか未署名かに関係なく、Java エンティティ タイプは Double です。
小さなテキスト	弦	-
文章	弦	-
年	日付	java.util.Date
列挙型	弦	-

【原理】

MyBatis-Plus フィールド型プロセッサ TypeHandler、この TypeHandler の位置はアプリケーションとデータベースの間のインターセプタであり、すべての操作はこれを経由します。@TableField は mybatis-plus のフィールドプロセッサで、フィールド型変換の問題を解決できますが、変換には typeHandler Class<? extends TypeHandler> 型プロセッサが必要です。

数据库类型与Java对象属性类型不对应，通过TypeHandler注解的方式，
setParameter方法可以解决插入、更新时的数据转换问题，
getResult方法查询时的数据类型转换问题。这里可以实现TypeHandler类型来实现自定义类型处理器。

[TypeHandler ソース コード。BaseTypeHandler および BigIntegerTypeHandler を参照して、TypeHandler を実装する独自のニーズに応じて処理クラスをカスタマイズできます]

 public interface TypeHandler<T> {
 
   /**
     * 入库前的类型转换；用于把 java 对象设置到 PreparedStatement 的参数中
    */
   void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;
 
   /**
     * 得到结果。
     * 查询后的数据处理； 用于从 ResultSet 中根据列名取出数据转换为 java 对象
    */
   T getResult(ResultSet rs, String columnName) throws SQLException;
  
    // 用于从 ResultSet 中根据索引位置取出数据转换为 java 对象
   T getResult(ResultSet rs, int columnIndex) throws SQLException;
     
   // 用于从 CallableStatement 中根据存储过程取出数据转换为 java 对象
   T getResult(CallableStatement cs, int columnIndex) throws SQLException;
 
 }

【BaseTypeHandlerはTypeHandlerを実装します】

 public abstract class BaseTypeHandler<T> extends TypeReference<T> implements TypeHandler<T> {
 
   @Override
   public void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException {
     if (parameter == null) {
       if (jdbcType == null) {
         throw new TypeException("JDBC requires that the JdbcType must be specified for all nullable parameters.");
       }
       try {
         ps.setNull(i, jdbcType.TYPE_CODE);
       } catch (SQLException e) {
         throw new TypeException("Error setting null for parameter #" + i + " with JdbcType " + jdbcType + " . "
               + "Try setting a different JdbcType for this parameter or a different jdbcTypeForNull configuration property. "
               + "Cause: " + e, e);
       }
     } else {
       try {
       // 设置不为null的参数，进行入库 ，此处是抽象类，下层还有实现类，
         setNonNullParameter(ps, i, parameter, jdbcType);
       } catch (Exception e) {
         throw new TypeException("Error setting non null for parameter #" + i + " with JdbcType " + jdbcType + " . "
               + "Try setting a different JdbcType for this parameter or a different configuration property. "
               + "Cause: " + e, e);
       }
     }
   }
 
   @Override
   public T getResult(ResultSet rs, String columnName) throws SQLException {
     try {
       //  这里从数据库中获取到数据，然后进行类型的一个设置
       return getNullableResult(rs, columnName);
     } catch (Exception e) {
       throw new ResultMapException("Error attempting to get column '" + columnName + "' from result set.  Cause: " + e, e);
     }
   }
 
   @Override
   public T getResult(ResultSet rs, int columnIndex) throws SQLException {
     try {
       return getNullableResult(rs, columnIndex);
     } catch (Exception e) {
       throw new ResultMapException("Error attempting to get column #" + columnIndex + " from result set.  Cause: " + e, e);
     }
   }
 
   @Override
   public T getResult(CallableStatement cs, int columnIndex) throws SQLException {
     try {
       return getNullableResult(cs, columnIndex);
     } catch (Exception e) {
       throw new ResultMapException("Error attempting to get column #" + columnIndex + " from callable statement.  Cause: " + e, e);
     }
   }
 
     // 这里就是设置为 不为 null 时的入库
   public abstract void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;
 
   /**
    * 获取可为空的结果。
    */
   public abstract T getNullableResult(ResultSet rs, String columnName) throws SQLException;
 
   public abstract T getNullableResult(ResultSet rs, int columnIndex) throws SQLException;
 
   public abstract T getNullableResult(CallableStatement cs, int columnIndex) throws SQLException;
 
 }
 

【BigIntegerTypeHandlerはBaseTypeHandlerを継承】

用于 java 类型 BigDecimal，jdbc 类型 REAL、DECIMAL、NUMERIC

public class BigIntegerTypeHandler extends BaseTypeHandler<BigInteger> {
 
   @Override
   public void setNonNullParameter(PreparedStatement ps, int i, BigInteger parameter, JdbcType jdbcType) throws SQLException {
     // 这里是转为 BigDecimal ,所以这里就算 setBigDecimal，
     // 那么我们就可以猜测，它还支持其他的方法，Date的话，那就是setDate
     ps.setBigDecimal(i, new BigDecimal(parameter));
   }
 
   @Override
   public BigInteger getNullableResult(ResultSet rs, String columnName) throws SQLException {
     BigDecimal bigDecimal = rs.getBigDecimal(columnName);
       // 这里是rs.getBigDecimal ,我们待会去试一下能否getDate就可以了
     return bigDecimal == null ? null : bigDecimal.toBigInteger();
   }
 
    // 这两个暂时没有做了解，Debug的时候，断点没有执行到这，后期再补一块的知识
    // 但是为了以防万一，我们待会也会照着它的方式将代码改成这样
   @Override
   public BigInteger getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
     BigDecimal bigDecimal = rs.getBigDecimal(columnIndex);
     return bigDecimal == null ? null : bigDecimal.toBigInteger();
   }
 
   @Override
   public BigInteger getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
     BigDecimal bigDecimal = cs.getBigDecimal(columnIndex);
     return bigDecimal == null ? null : bigDecimal.toBigInteger();
   }
 }
 

【練習する】

実際の開発では、org.apache.ibatis.type.BaseTypeHandler 型を継承してカスタム型プロセッサを実装できます。この型は抽象型であり、次に示すように、一般的なプロセスをカプセル化する TypeHandler メソッドを実装し、例外を処理し、いくつかの同様の抽象メソッドを定義します。
BaseTypeHandler 型を継承すると、開発の難易度が大幅に軽減されます。
·

【例】User にリスト型の属性があり、データベースに保存される対応するフィールドが VARCHAR 型である。挿入時にはTypeHandlerを使ってList型データをString型に変換する処理が必要で、クエリ時にはクエリ文字列をList型に変換する必要があります。

1. BaseTypeHandler を継承してカスタム TypeHandler を実装する

public class ListTypeHandler extends BaseTypeHandler<List<String>> {

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, List<String> parameter, JdbcType jdbcType) throws SQLException {
        ps.setString(i, String.join(",", parameter));
    }

    @Override
    public List<String> getNullableResult(ResultSet rs, String columnName) throws SQLException {
        String s = rs.getString(columnName);
        return s == null ? null : Arrays.asList(s.split(","));
    }

    @Override
    public List<String> getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        String s = rs.getString(columnIndex);
        return s == null ? null : Arrays.asList(s.split(","));
    }

    @Override
    public List<String> getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        String s = cs.getString(columnIndex);
        return s == null ? null : Arrays.asList(s.split(","));
    }
}

2. 指定したフィールドに注釈を付けます

@TableField(typeHandler = ListTypeHandler .class)

AbstractJsonTypeHandler

mybatisplus は、FastJson、Gson、Jackson json の AbstractJsonTypeHandler の実装クラスを Java オブジェクトに提供しました。

//json从数据库中取出转换成对象

@TableField(typeHandler = FastjsonTypeHandler.class)
private 实体类 xxx;

補充する

エンティティ クラスでマッピング アノテーションを使用する:
@TableName(value = “a”, autoResultMap = true)
autoResultMap パラメーターが true の場合、クエリ処理中に個々のフィールドが自動的にオブジェクトに変換されることを示します。これは、TypeHandler とjdbcTyped が設定されます。autoResultMap は自動的にマッピングを行い、通常はマッピングの標準化を決定するために @TableField() と一緒に使用されます。