36.3. 使用 Annotations 实现类型转换器
概述
类型转换机制可以通过添加新的 worker 类型转换程序来轻松自定义。本节论述了如何实现 worker 类型转换器以及如何将其与 Apache Camel 集成,以便注解类型转换程序自动加载它。
如何实现类型转换器
实施注解的转换器类
您可以使用 @Converter
注释实施自定义类型转换器类。您必须注解类本身,以及用于执行类型转换的每种 静态方法
。每个转换器方法都使用一个参数来定义 来自 类型,可选择使用第二个 Exchange
参数,并且具有 定义要 类型的非void 返回值。类型转换程序使用 Java 反应来查找注解的方法,并将它们集成到类型转换器机制中。例 36.3 “注解的 Converter 类示例” 显示注解的转换器类示例,它定义了转换器方法,用于从 java.io.File
转换为 java.io.InputStream
和另一个转换器方法(使用 Exchange
参数),用于将 from byte[]
转换为 String
。
例 36.3. 注解的 Converter 类示例
package com.YourDomain.YourPackageName; import org.apache.camel.Converter; import java.io.*; @Converter public class IOConverter { private IOConverter() { } @Converter public static InputStream toInputStream(File file) throws FileNotFoundException { return new BufferedInputStream(new FileInputStream(file)); } @Converter public static String toString(byte[] data, Exchange exchange) { if (exchange != null) { String charsetName = exchange.getProperty(Exchange.CHARSET_NAME, String.class); if (charsetName != null) { try { return new String(data, charsetName); } catch (UnsupportedEncodingException e) { LOG.warn("Can't convert the byte to String with the charset " + charsetName, e); } } } return new String(data); } }
toInputStream()
方法负责将从 File
类型转换为 InputStream
类型,而 toString()
方法负责执行从 byte[]
类型到 String
类型的转换。
方法名称不重要,可以是您选择的任何内容。重要的是参数类型、返回类型和是否存在 @Converter
注释。
创建 TypeConverter 文件
要为自定义转换器启用发现机制(由 注解类型转换程序实现),请在以下位置创建一个 TypeConverter
文件:
META-INF/services/org/apache/camel/TypeConverter
TypeConverter
文件必须包含类型为 converter 类的 Fully Qualified Names(FQN)列表。例如,如果您想要类型转换程序加载程序来搜索 您的PackageName.
YourClassName 软件包,用于注解的转换器类,TypeConverter
文件将包含以下内容:
com.PackageName.FooClass
启用发现机制的替代方法是将软件包名称添加到 TypeConverter
文件。例如,TypeConverter
文件将包含以下内容:
com.PackageName
这将导致软件包扫描程序通过 @Converter
标签的软件包扫描。使用 FQN 方法更快,是首选的方法。
软件包类型转换器
类型转换器被打包为 JAR 文件,其中包含自定义类型转换器的编译类和 META-INF
目录。将这个 JAR 文件放在您的类路径上,使其可用于 Apache Camel 应用程序。
fallback converter 方法
除了使用 @Converter
注释定义常规转换器方法外,您还可以使用 @FallbackConverter
注释来定义回退转换器方法。只有在控制器类型转换器无法在类型 registry 中找到常规转换器方法时,才会尝试回退转换器方法。
常规转换方法和回退转换方法之间基本区别是,而常规转换器则定义了在特定对类型的转换(例如,从 字节[]
到 String
),而回退转换器 可以在任何 对类型间执行转换。最多是回退转换器方法正文中的代码,以找出它能够执行的转换。在运行时,如果转换无法通过常规转换器执行转换,控制器类型转换器会迭代每个可用的回退转换器,直到它找到可以执行转换的转换。
回退转换器的方法签名可以采用以下格式之一:
// 1. Non-generic form of signature @FallbackConverter public static Object MethodName( Class type, Exchange exchange, Object value, TypeConverterRegistry registry ) // 2. Templating form of signature @FallbackConverter public static <T> T MethodName( Class<T> type, Exchange exchange, Object value, TypeConverterRegistry registry )
其中 MethodName 是回退转换器的任意方法名称。
例如,以下代码提取(来自 File 组件的实现中)会显示一个回退转换器,它可转换 GenericFile
对象的正文,利用类型转换器在类型转换器中已有的转换器:
package org.apache.camel.component.file; import org.apache.camel.Converter; import org.apache.camel.FallbackConverter; import org.apache.camel.Exchange; import org.apache.camel.TypeConverter; import org.apache.camel.spi.TypeConverterRegistry; @Converter public final class GenericFileConverter { private GenericFileConverter() { // Helper Class } @FallbackConverter public static <T> T convertTo(Class<T> type, Exchange exchange, Object value, TypeConverterRegistry registry) { // use a fallback type converter so we can convert the embedded body if the value is GenericFile if (GenericFile.class.isAssignableFrom(value.getClass())) { GenericFile file = (GenericFile) value; Class from = file.getBody().getClass(); TypeConverter tc = registry.lookup(type, from); if (tc != null) { Object body = file.getBody(); return tc.convertTo(type, exchange, body); } } return null; } ... }