検索
ホームページJava&#&チュートリアルMybatisシリーズ徹底入門(5) ---TypeHandlerの導入と設定(mybatisソースコード)

前回の記事「Mybatisシリーズ徹底解説(4)---typeAliasesエイリアスの詳細構成(mybatisソースコード)」では、mybatisにおけるエイリアスの使い方とそのソースコードについて紹介しました。この記事では、TypeHandler を紹介し、そのソース コードを簡単に分析します。

Mybatis の TypeHandler とは何ですか?

MyBatis が準備済みステートメント (PreparedStatement) にパラメーターを設定する場合でも、結果セットから値を取得する場合でも、型プロセッサーを使用して、取得した値を適切な方法で Java 型に変換します。 Mybatis はデフォルトで多くの TypeHandler を実装します。指定された TypeHandler を設定しない場合、Mybatis はパラメータまたは返される結果に基づいて適切な TypeHandler をデフォルトで選択します。

では、Mybatis はどのような TypeHandler を実装しているのでしょうか? TypeHandler をカスタマイズするにはどうすればよいでしょうか? これらは、次に mybatis のソース コードで説明します。

ソースコードを見る前に、先ほどと同じように設定する方法を見てみましょう。

TypeHandler の設定:

<configuration>
    <typehandlers>
      <!-- 
          当配置package的时候,mybatis会去配置的package扫描TypeHandler
          <package name="com.dy.demo"/>       -->
      
      <!-- handler属性直接配置我们要指定的TypeHandler -->
      <typehandler></typehandler>
      
      <!-- javaType 配置java类型,例如String, 如果配上javaType, 那么指定的typeHandler就只作用于指定的类型 -->
      <typehandler></typehandler>
      
      <!-- jdbcType 配置数据库基本数据类型,例如varchar, 如果配上jdbcType, 那么指定的typeHandler就只作用于指定的类型  -->
      <typehandler></typehandler>
      
      <!-- 也可两者都配置 -->
      <typehandler></typehandler>
      
  </typehandlers>
  
  ......  
</configuration>

以上で TypeHandler について簡単に紹介しました。次に、mybatis の TypeHandler のソース コードを見てみましょう。


============================================ ===== ============私はソースコードの分割線です========================== ========== =========================

古いルール、XML の解析から始めましょう:


/**
 * 解析typeHandlers节点 */private void typeHandlerElement(XNode parent) throws Exception {    if (parent != null) {      for (XNode child : parent.getChildren()) {        //子节点为package时,获取其name属性的值,然后自动扫描package下的自定义typeHandler
        if ("package".equals(child.getName())) {
          String typeHandlerPackage = child.getStringAttribute("name");
          typeHandlerRegistry.register(typeHandlerPackage);
        } else {          //子节点为typeHandler时, 可以指定javaType属性, 也可以指定jdbcType, 也可两者都指定          //javaType 是指定java类型          //jdbcType 是指定jdbc类型(数据库类型: 如varchar)
          String javaTypeName = child.getStringAttribute("javaType");
          String jdbcTypeName = child.getStringAttribute("jdbcType");          //handler就是我们配置的typeHandler
          String handlerTypeName = child.getStringAttribute("handler");          //resolveClass方法就是我们上篇文章所讲的TypeAliasRegistry里面处理别名的方法
          Class> javaTypeClass = resolveClass(javaTypeName);          //JdbcType是一个枚举类型,resolveJdbcType方法是在获取枚举类型的值
          JdbcType jdbcType = resolveJdbcType(jdbcTypeName);
          Class> typeHandlerClass = resolveClass(handlerTypeName);          //注册typeHandler, typeHandler通过TypeHandlerRegistry这个类管理
          if (javaTypeClass != null) {            if (jdbcType == null) {
              typeHandlerRegistry.register(javaTypeClass, typeHandlerClass);
            } else {
              typeHandlerRegistry.register(javaTypeClass, jdbcType, typeHandlerClass);
            }
          } else {
            typeHandlerRegistry.register(typeHandlerClass);
          }
        }
      }
    }
}


次は、TypeHandler の管理登録クラスを見てみましょう:

TypeHandlerRegistry:

/**
 * typeHandler注册管理类 */public final class TypeHandlerRegistry {  
 //源码一上来,二话不说,几个大大的HashMap就出现,这不又跟上次讲的typeAliases的注册类似么  
 //基本数据类型与其包装类
  private static final Map<class>, Class>> reversePrimitiveMap = new HashMap<class>, Class>>() {    private static final long serialVersionUID = 1L;
    {
      put(Byte.class, byte.class);
      put(Short.class, short.class);
      put(Integer.class, int.class);
      put(Long.class, long.class);
      put(Float.class, float.class);
      put(Double.class, double.class);
      put(Boolean.class, boolean.class);
      put(Character.class, char.class);
    }
  };  //这几个MAP不用说就知道存的是什么东西吧,命名的好处
  private final Map<jdbctype>> JDBC_TYPE_HANDLER_MAP = new EnumMap<jdbctype>>(JdbcType.class);  private final Map<type>>> TYPE_HANDLER_MAP = new HashMap<type>>>();  private final TypeHandler<object> UNKNOWN_TYPE_HANDLER = new UnknownTypeHandler(this);  private final Map<class>, TypeHandler>> ALL_TYPE_HANDLERS_MAP = new HashMap<class>, TypeHandler>>();  //就像上篇文章讲的typeAliases一样,mybatis也默认给我们注册了不少的typeHandler  //具体如下
  public TypeHandlerRegistry() {
    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(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 ClobTypeHandler());
    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 ClobTypeHandler());
    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(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, UNKNOWN_TYPE_HANDLER);
    register(Object.class, JdbcType.OTHER, UNKNOWN_TYPE_HANDLER);
    register(JdbcType.OTHER, UNKNOWN_TYPE_HANDLER);

    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());    // issue #273
    register(Character.class, new CharacterTypeHandler());
    register(char.class, new CharacterTypeHandler());
  }  public boolean hasTypeHandler(Class> javaType) {    return hasTypeHandler(javaType, null);
  }  public boolean hasTypeHandler(TypeReference> javaTypeReference) {    return hasTypeHandler(javaTypeReference, null);
  }  public boolean hasTypeHandler(Class> javaType, JdbcType jdbcType) {    return javaType != null && getTypeHandler((Type) javaType, jdbcType) != null;
  }  public boolean hasTypeHandler(TypeReference> javaTypeReference, JdbcType jdbcType) {    return javaTypeReference != null && getTypeHandler(javaTypeReference, jdbcType) != null;
  }  public TypeHandler> getMappingTypeHandler(Class extends TypeHandler>> handlerType) {    return ALL_TYPE_HANDLERS_MAP.get(handlerType);
  }  public <t> TypeHandler<t> getTypeHandler(Class<t> type) {    return getTypeHandler((Type) type, null);
  }  public <t> TypeHandler<t> getTypeHandler(TypeReference<t> javaTypeReference) {    return getTypeHandler(javaTypeReference, null);
  }  public TypeHandler> getTypeHandler(JdbcType jdbcType) {    return JDBC_TYPE_HANDLER_MAP.get(jdbcType);
  }  public <t> TypeHandler<t> getTypeHandler(Class<t> type, JdbcType jdbcType) {    return getTypeHandler((Type) type, jdbcType);
  }  public <t> TypeHandler<t> getTypeHandler(TypeReference<t> javaTypeReference, JdbcType jdbcType) {    return getTypeHandler(javaTypeReference.getRawType(), jdbcType);
  }  private <t> TypeHandler<t> getTypeHandler(Type type, JdbcType jdbcType) {
    Map<jdbctype>> jdbcHandlerMap = TYPE_HANDLER_MAP.get(type);
    TypeHandler> handler = null;    if (jdbcHandlerMap != null) {
      handler = jdbcHandlerMap.get(jdbcType);      if (handler == null) {
        handler = jdbcHandlerMap.get(null);
      }
    }    if (handler == null && type != null && type instanceof Class && Enum.class.isAssignableFrom((Class>) type)) {
      handler = new EnumTypeHandler((Class>) type);
    }
    @SuppressWarnings("unchecked")    // type drives generics here
    TypeHandler<t> returned = (TypeHandler<t>) handler;    return returned;
  }  public TypeHandler<object> getUnknownTypeHandler() {    return UNKNOWN_TYPE_HANDLER;
  }  public void register(JdbcType jdbcType, TypeHandler> handler) {
    JDBC_TYPE_HANDLER_MAP.put(jdbcType, handler);
  }  //
  // REGISTER INSTANCE  
  //
  /**
   * 只配置了typeHandler, 没有配置jdbcType 或者javaType   
   */
  @SuppressWarnings("unchecked")  public <t> void register(TypeHandler<t> typeHandler) {    
  boolean mappedTypeFound = false;    
  //在自定义typeHandler的时候,可以加上注解MappedTypes 去指定关联的javaType    
  //因此,此处需要扫描MappedTypes注解
    MappedTypes mappedTypes = typeHandler.getClass().getAnnotation(MappedTypes.class);    
    if (mappedTypes != null) {      
    for (Class> handledType : mappedTypes.value()) {
        register(handledType, typeHandler);
        mappedTypeFound = true;
      }
    }    // @since 3.1.0 - try to auto-discover the mapped type
    if (!mappedTypeFound && typeHandler instanceof TypeReference) {      try {
        TypeReference<t> typeReference = (TypeReference<t>) typeHandler;
        register(typeReference.getRawType(), typeHandler);
        mappedTypeFound = true;
      } catch (Throwable t) {        
      // maybe users define the TypeReference with a different type and are not assignable, so just ignore it     
       }
    }    if (!mappedTypeFound) {
      register((Class<t>) null, typeHandler);
    }
  }  /**
   * 配置了typeHandlerhe和javaType   */
  public <t> void register(Class<t> javaType, TypeHandler extends T> typeHandler) {
    register((Type) javaType, typeHandler);
  }  private <t> void register(Type javaType, TypeHandler extends T> typeHandler) {    
  //扫描注解MappedJdbcTypes
    MappedJdbcTypes mappedJdbcTypes = typeHandler.getClass().getAnnotation(MappedJdbcTypes.class);    
    if (mappedJdbcTypes != null) {      
    for (JdbcType handledJdbcType : mappedJdbcTypes.value()) {
        register(javaType, handledJdbcType, typeHandler);
      }      if (mappedJdbcTypes.includeNullJdbcType()) {
        register(javaType, null, typeHandler);
      }
    } else {
      register(javaType, null, typeHandler);
    }
  }  public <t> void register(TypeReference<t> javaTypeReference, TypeHandler extends T> handler) {
    register(javaTypeReference.getRawType(), handler);
  }  /**
   * typeHandlerhe、javaType、jdbcType都配置了   */
  public <t> void register(Class<t> type, JdbcType jdbcType, TypeHandler extends T> handler) {
    register((Type) type, jdbcType, handler);
  }  /**
   * 注册typeHandler的核心方法
   * 就是向Map新增数据而已   */
  private void register(Type javaType, JdbcType jdbcType, TypeHandler> handler) {    
  if (javaType != null) {
      Map<jdbctype>> map = TYPE_HANDLER_MAP.get(javaType);      
      if (map == null) {
        map = new HashMap<jdbctype>>();
        TYPE_HANDLER_MAP.put(javaType, map);
      }
      map.put(jdbcType, handler);      
      if (reversePrimitiveMap.containsKey(javaType)) {
        register(reversePrimitiveMap.get(javaType), jdbcType, handler);
      }
    }
    ALL_TYPE_HANDLERS_MAP.put(handler.getClass(), handler);
  }  //
  // REGISTER CLASS  //

  // Only handler type

  public void register(Class> typeHandlerClass) {    
  boolean mappedTypeFound = false;
    MappedTypes mappedTypes = typeHandlerClass.getAnnotation(MappedTypes.class);    
    if (mappedTypes != null) {      
    for (Class> javaTypeClass : mappedTypes.value()) {
        register(javaTypeClass, typeHandlerClass);
        mappedTypeFound = true;
      }
    }    if (!mappedTypeFound) {
      register(getInstance(null, typeHandlerClass));
    }
  }  // java type + handler type

  public void register(Class> javaTypeClass, Class> typeHandlerClass) {
    register(javaTypeClass, getInstance(javaTypeClass, typeHandlerClass));
  }  // java type + jdbc type + handler type

  public void register(Class> javaTypeClass, JdbcType jdbcType, Class> typeHandlerClass) {
    register(javaTypeClass, jdbcType, getInstance(javaTypeClass, typeHandlerClass));
  }  // Construct a handler (used also from Builders)
  @SuppressWarnings("unchecked")  public <t> TypeHandler<t> getInstance(Class> javaTypeClass, Class> typeHandlerClass) {    if (javaTypeClass != null) {      try {
        Constructor> c = typeHandlerClass.getConstructor(Class.class);        
        return (TypeHandler<t>) c.newInstance(javaTypeClass);
      } catch (NoSuchMethodException ignored) {        
      // ignored
      } catch (Exception e) {        
      throw new TypeException("Failed invoking constructor for handler " + typeHandlerClass, e);
      }
    }    try {
      Constructor> c = typeHandlerClass.getConstructor();      
      return (TypeHandler<t>) c.newInstance();
    } catch (Exception e) {     
     throw new TypeException("Unable to find a usable constructor for " + typeHandlerClass, e);
    }
  } 
  /**
   * 根据指定的pacakge去扫描自定义的typeHander,然后注册   */
  public void register(String packageName) {
    ResolverUtil<class>> resolverUtil = new ResolverUtil<class>>();
    resolverUtil.find(new ResolverUtil.IsA(TypeHandler.class), packageName);
    Set<class>>> handlerSet = resolverUtil.getClasses();    
    for (Class> type : handlerSet) {      
    //Ignore inner classes and interfaces (including package-info.java) and abstract classes
      if (!type.isAnonymousClass() && !type.isInterface() && !Modifier.isAbstract(type.getModifiers())) {
        register(type);
      }
    }
  }  
  // get information
  
  /**
   * 通过configuration对象可以获取已注册的所有typeHandler   */
  public Collection<typehandler>> getTypeHandlers() {    
  return Collections.unmodifiableCollection(ALL_TYPE_HANDLERS_MAP.values());
  }
  
}</typehandler></class></class></class></t></t></t></t></jdbctype></jdbctype></t></t></t></t></t></t></t></t></t></t></t></t></object></t></t></jdbctype></t></t></t></t></t></t></t></t></t></t></t></t></t></t></class></class></object></type></type></jdbctype></jdbctype></class></class>


ソース コードからわかるように、mybatis は TypeHandler を開くだけで非常に多くの TypeHandler を実装しています。ソース コードを見ると、抽象クラス BaseTypeHandler を継承していることがわかります。したがって、BaseTypeHandler を継承してカスタム TypeHandler を実装することもできます。答えは「はい」です。それでは、カスタム TypeHandler を説明します。 ===== ============================================ == カスタム TypeHandler 分割線=========================================== ==== ============ExampleTypeHandler:

@MappedJdbcTypes(JdbcType.VARCHAR)  
//此处如果不用注解指定jdbcType, 那么,就可以在配置文件中通过"jdbcType"属性指定, 同理, javaType 也可通过 @MappedTypes指定public class ExampleTypeHandler extends BaseTypeHandler<string> {

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

  @Override  public String getNullableResult(ResultSet rs, String columnName) throws SQLException {    return rs.getString(columnName);
  }

  @Override  public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {    return rs.getString(columnIndex);
  }

  @Override  public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {    return cs.getString(columnIndex);
  }
}</string>

次に、カスタム TypeHandler:


<configuration>
  <typehandlers>
      <!-- 由于自定义的TypeHandler在定义时已经通过注解指定了jdbcType, 所以此处不用再配置jdbcType -->
      <typehandler></typehandler>
  </typehandlers>
  
  ......  
</configuration>


を構成します。 TypeHandler を定義するときは、TypeHandler の @MappedJdbcTypes を通じて jdbcType を指定でき、アノテーションを使用して指定されていない場合は、構成ファイルで設定する必要があります。


さて、この記事はここで終わります。

上記は Mybatis シリーズの詳細な紹介 (5) ---TypeHandler の導入と設定 (mybatis ソース コード) より多くの関連コンテンツについては、PHP 中国語 Web サイト (www.php.cn) に注目してください。 !


声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
高度なJavaプロジェクト管理、自動化の構築、依存関係の解像度にMavenまたはGradleを使用するにはどうすればよいですか?高度なJavaプロジェクト管理、自動化の構築、依存関係の解像度にMavenまたはGradleを使用するにはどうすればよいですか?Mar 17, 2025 pm 05:46 PM

この記事では、Javaプロジェクト管理、自動化の構築、依存関係の解像度にMavenとGradleを使用して、アプローチと最適化戦略を比較して説明します。

適切なバージョン化と依存関係管理を備えたカスタムJavaライブラリ(JARファイル)を作成および使用するにはどうすればよいですか?適切なバージョン化と依存関係管理を備えたカスタムJavaライブラリ(JARファイル)を作成および使用するにはどうすればよいですか?Mar 17, 2025 pm 05:45 PM

この記事では、MavenやGradleなどのツールを使用して、適切なバージョン化と依存関係管理を使用して、カスタムJavaライブラリ(JARファイル)の作成と使用について説明します。

カフェインやグアバキャッシュなどのライブラリを使用して、Javaアプリケーションにマルチレベルキャッシュを実装するにはどうすればよいですか?カフェインやグアバキャッシュなどのライブラリを使用して、Javaアプリケーションにマルチレベルキャッシュを実装するにはどうすればよいですか?Mar 17, 2025 pm 05:44 PM

この記事では、カフェインとグアバキャッシュを使用してJavaでマルチレベルキャッシュを実装してアプリケーションのパフォーマンスを向上させています。セットアップ、統合、パフォーマンスの利点をカバーし、構成と立ち退きポリシー管理Best Pra

キャッシュや怠zyなロードなどの高度な機能を備えたオブジェクトリレーショナルマッピングにJPA(Java Persistence API)を使用するにはどうすればよいですか?キャッシュや怠zyなロードなどの高度な機能を備えたオブジェクトリレーショナルマッピングにJPA(Java Persistence API)を使用するにはどうすればよいですか?Mar 17, 2025 pm 05:43 PM

この記事では、キャッシュや怠zyなロードなどの高度な機能を備えたオブジェクトリレーショナルマッピングにJPAを使用することについて説明します。潜在的な落とし穴を強調しながら、パフォーマンスを最適化するためのセットアップ、エンティティマッピング、およびベストプラクティスをカバーしています。[159文字]

Javaのクラスロードメカニズムは、さまざまなクラスローダーやその委任モデルを含むどのように機能しますか?Javaのクラスロードメカニズムは、さまざまなクラスローダーやその委任モデルを含むどのように機能しますか?Mar 17, 2025 pm 05:35 PM

Javaのクラスロードには、ブートストラップ、拡張機能、およびアプリケーションクラスローダーを備えた階層システムを使用して、クラスの読み込み、リンク、および初期化が含まれます。親の委任モデルは、コアクラスが最初にロードされ、カスタムクラスのLOAに影響を与えることを保証します

See all articles

ホットAIツール

Undresser.AI Undress

Undresser.AI Undress

リアルなヌード写真を作成する AI 搭載アプリ

AI Clothes Remover

AI Clothes Remover

写真から衣服を削除するオンライン AI ツール。

Undress AI Tool

Undress AI Tool

脱衣画像を無料で

Clothoff.io

Clothoff.io

AI衣類リムーバー

AI Hentai Generator

AI Hentai Generator

AIヘンタイを無料で生成します。

ホットツール

MantisBT

MantisBT

Mantis は、製品の欠陥追跡を支援するために設計された、導入が簡単な Web ベースの欠陥追跡ツールです。 PHP、MySQL、Web サーバーが必要です。デモおよびホスティング サービスをチェックしてください。

SAP NetWeaver Server Adapter for Eclipse

SAP NetWeaver Server Adapter for Eclipse

Eclipse を SAP NetWeaver アプリケーション サーバーと統合します。

VSCode Windows 64 ビットのダウンロード

VSCode Windows 64 ビットのダウンロード

Microsoft によって発売された無料で強力な IDE エディター

SublimeText3 英語版

SublimeText3 英語版

推奨: Win バージョン、コードプロンプトをサポート!

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

強力な PHP 統合開発環境