自定义类加载器使用geotools读取高程报 ImageRead: No OperationDescriptor is registered 问题

背景

项目中使用了 自定义classLoader ,，然后使用下面简化后的代码读取高程数据

public class Test{
	public static void main(String[] args) throwS Exception{
		CustomClassLoader cl = new CustomClassLoader();
		Class<?> clazz = cl.loadClass(“Test”);
		Test test =(Test)clazz.newInstance();
		test.readTiff(cl);
	}

	public void readTiff(){
		//读取基础dem文件
        		File file = new File(“a.tif”);
        		//tiff读取器
        		GeoTiffReader tifReader = new GeoTiffReader(file, tiffHints);
        		//读取tiff，获得基础GridCoverage2D 。
        		GridCoverage2D coverage = tifReader.read(null);
	}
}

此时会报如下错误 ImageRead: No OperationDescriptor is registered in the current operation registry under this name.

注意:项目中 geotools 的相关 jar 包都是由自定义classLoader加载的, AppClassLoader  中并没有加载 geotools 相关 jar 包，这也是问题产生的前提条件。

相关依赖如下所示

 <dependency>
            <groupId>org.geotools</groupId>
            <artifactId>gt-epsg-hsql</artifactId>
            <version>22.0</version>
        </dependency>
        <dependency>
            <groupId>org.geotools</groupId>
            <artifactId>gt-geotiff</artifactId>
            <version>22.0</version>
        </dependency>

解决方案:

方案1：用 AppClassLoader 加载  geotools 相关的jar包

方案2：代码改为如下所示，和上面代码区别在于增加了 init 方法

public class Test{
	public static void main(String[] args) throwS Exception{
		CustomClassLoader cl = new CustomClassLoader();
		Class<?> clazz = cl.loadClass(“Test”);
		Test test =(Test)clazz.newInstance();

		test.init(cl);

		test.readTiff(cl);
	}

	boolean firstInit =true;
	/**
	* 初始化进行JAI的注册
	* 此方法会加载ImageReader
	*/
	public void init(ClassLoader cl){
		if(firstInit){
            //先触发 JAI 静态代码块使用 系统类加载器加载render
            JAI.getDefaultInstance();
            //设置当前线程类加载器为自定义类加载器.
            Thread.currentThread().setContextClassLoader(cl);
            //主动调用注册render的方法
			JAI.getDefaultInstance().getOperationRegistry().registerServices(cl);
			firstInit=false;
		}
	}
	public void readTiff(){
		//读取基础dem文件
        		File file = new File(“a.tif”);
        		//tiff读取器
        		GeoTiffReader tifReader = new GeoTiffReader(file, tiffHints);
        		//读取tiff，获得基础GridCoverage2D 。
        		GridCoverage2D coverage = tifReader.read(null);
	}
}

 原因分析:

首先报错是在如下图所示的地方，此处 render 只加载了 97 个，而实际情况是应该加载 102 个,97中并不包含 ImageReader，于是 getDescriptor 的时候就报错了。调用链路为 GeoTiffReader.read -> JAI.create -> JAI.createNS。

而 render 内容加载是在如下图所示的地方，而这个方法是由JAI中的的静态代码块触发的，没有提供相关图片。静态代码块只在第一次被类加载的时候执行一次

上图中两个序号标识的地方会以不同方式会创建 render

        序号①：这个地方地方会从 jai_core.jar 中的 javax.media.jai.registryFile.jai文件中加载 97个 render ,就是前面提到的 97 个 render 。

        序号②：这个地方按我项目中正常情况是应该要加载5个render的，其中就包含ImagerReader，而背景中的问题代码从这个地方却只加载了 0 个，所以问题就产生在序号②方法里面的逻辑。注意，此处传入的ClassLoader 是 null

 序号②方法里面的逻辑如下图所示

图中有两个方法，也是会以两种不同方式创建 render 

        第1个红框：

        上面提到过此方法传入进来的 classLoader 是 null，于是会走第一个 if，会从系统的 classLoader 即 AppClassLoader 中加载所有 jar 包中的  META-INF/registryFile.jai 文件中的 render ，但前面强调过了，geotools 的相关 jar 包都是通过 自定义classLoader 加 载的，而 META-INF/registryFile.jai  是在 geotools 的 jar 包中，所以系统的 AppClassLoader 自然是加载不到任何的 render 的。

        所以如果要加载到 META-INF/registryFile.jai 中的 render 要么让 AppClassLoader  加载 geotools 的相关 jar 包,要么此处传入的 classLoader  为 自定义classLoader。

        不过这个地方加载的 render  不包含  ImagerReader 。所以没加载对本项目中的错误不会有影响。

         第2个红框：

        此处会从当前线程的类加载器读取 spi 中的 render 进行加载。，和上面一样，由于包含 render 的 spi 文件还是在 geotools 相关的 jar 包中，所以此处如果不是 自定义classLoader 依然会加载不到 render 。而如果没有特意设置当前线程的类加载器为 自定义classLoader，则使用的还是 AppClassLoader 

        此处加载的 render 包括 ImageReader ，于是就产生了本文章的错误。

解决思路  (其实就是开头的两种解决方案)

思路1：
         就是让 AppClassLoader  加载 geotools 相关的 jar 包。

思路2:
        设置当前线程的类加载器为自定义classLoader，然后主动调用JAI.getDefaultInstance().getOperationRegistry().registerServices(自定义classLoader) 注册 render ，并传入自定义classLoader.这样上面第1个红框和第2个红框就都可以使用 自定义classLoader 加载 render。
        需要注意的是在设置当前线程的类加载器为 自定义classLoader 之前,需要先触发 JAI 的类加载，从而执行 JAI 的静态代码块使用 AppClassLoader  进行一次 render 的注册。否则 JAI 的静态代码块注册 render 时,会使用 自定义classLoader ,注册一次 ImageReader，然后主动注册时 ImageReader 又会注册一次，就会报重复注册的错误。