jar包冲突之URLClassLoader加载指定jar

Jar包冲突场景

最近项目中用到了SM4加密，发现 bcprov-jdk15on-1.59.jar 和 BJCA-JCE2.jar 两个jar包中存在有两个包路径相同的类：

import org.bouncycastle.jce.provider.BouncyCastleProvider;
import org.bouncycastle.util.encoders.Hex;
导致本该创建bcprov-jdk15on-1.59.jar包的 BouncyCastleProvider 和Hex实体类错误的引用了BJCA-JCE2.jar包的BouncyCastleProvider 和Hex实体类，导致加密报错：No such algorithm: SM4/ECB/PKCS5Padding

冲突部分代码如下：

 static {
        Security.addProvider(new BouncyCastleProvider());
    }

 String hexKey = new String(Hex.encode(key.getBytes("UTF-8")));

Jar包冲突解决

解决方案一

如果是jar包存在多个版本造成的冲突，可以通过定位到冲突的jar然后删除无用版本的jar包来解决，而此项目中 bcprov-jdk15on-1.59.jar 和 BJCA-JCE2.jar 两个jar包都要使用，会根据不同的环境去调用不同的加密规则，所以不能此方案来解决。

解决方案二

可以将bcprov-jdk15on-1.59.jar 的源码包下载到本地，然后去修改冲突的包名，再把修改后的源码包重新打成jar包替换原有jar，但是此种方案打好的jar包，可能会报错：JCE cannot authenticate the provider BC ；
这是因为bcprov-jdk15on-1.59.jar打包时，会将签名破坏掉，导致在使用这个签名被破坏的包中的类时，就会报错了，可能是我的打包方式不对，如果有好的解决办法可以评论讨论下哦。

解决方案三

可以将bcprov-jdk15on-1.59.jar 放在JAVA_HOME/jre/lib/ext路径下，
这样可以通过双亲委派机制优先加载JAVA_HOME/jre/lib/ext路径下的
bcprov-jdk15on-1.59.jar包，但是如果再去调用BJCA-JCE2.jar包中的加密方法也会优先加载bcprov-jdk15on-1.59.jar的冲突类，这样还是会有冲突问题。

解决方案四

最终通过URLClassLoader 去指定加载指定的jar包，然后通过反射去实例化对象并调用冲突方法来解决。新建两个工具类SM4ClassLoaderUtil 和 JCEClassLoaderUtil ，下面只展示SM4ClassLoaderUtil类代码，JCEClassLoaderUtil类似，只是加载的jar包不同，具体代码如下：

 public abstract class SM4ClassLoaderUtil {
    private static Logger logger = Logger.getLogger(SM4ClassLoaderUtil.class);
    private static URLClassLoader clsLoader;
    private static Class hexClass;
    private static Class bouncyCastleProviderClass;
    private static final String BOUNCY_CAST_CASTLE_PROVIDER_PACKAGE = "org.bouncycastle.jce.provider.BouncyCastleProvider";
    private static final String HEX_PACKAGE = "org.bouncycastle.util.encoders.Hex";
    private static final String LOAD_JAR_DEFAULT_NAME = "bcprov-jdk15on-1.59.jar";


    /**
     * 类加载bcprov-jdk15on-1.59.jar
     */
    static{
        try {

            String path = getJarPath();
            logger.info(LOAD_JAR_DEFAULT_NAME + " 路径地址："+path);

            //加载bcprov-jdk15on-1.59.jar包，WEB-INF 下lib包
            clsLoader = getUrlClassLoader(path);

            //加载需要使用的类（包名称加上类名）
            loadClass();
            logger.info(LOAD_JAR_DEFAULT_NAME + "被加载了！");

        } catch (Exception e) {
            logger.error(LOAD_JAR_DEFAULT_NAME + "加载失败！，原因：" + e.getMessage());
        }
    }

    /**
     * 实例化BouncyCastleProvider
     */
    protected static Provider getBouncyCastleProviderInstance() throws Exception {
        return (Provider)bouncyCastleProviderClass.newInstance();
    }

    /**
     * 获取jar路径
     */
    private static String  getJarPath(){
        return Thread.currentThread().getContextClassLoader().getResource("").toString()
                .replace("classes","lib");
    }

    /**
     * 获取类加载器
     */
    private static URLClassLoader  getUrlClassLoader(String path) throws MalformedURLException {
        return URLClassLoader.newInstance(new URL[] { new URL(path + LOAD_JAR_DEFAULT_NAME)});
    }

    /**
     * 加载类
     */
    private static void  loadClass() throws  ClassNotFoundException {
        bouncyCastleProviderClass = clsLoader.loadClass(BOUNCY_CAST_CASTLE_PROVIDER_PACKAGE);
        hexClass = clsLoader.loadClass(HEX_PACKAGE);
    }


    /**
     * 反射调用指定方法
     * @param source
     */
    protected static String hexEncode(String source) {
        try {
            byte[] msg = source.getBytes("UTF-8");
            //实例化对象
            Object haxObject = hexClass.newInstance();
            //调用需要调用的方法（通过反射）
            Method encode =hexClass.getMethod("encode", byte[].class);
            //私有调用 encode.setAccessible(true);
            byte[] haxEncodeString =(byte[])encode.invoke(haxObject, msg);
            String s = new String(haxEncodeString);
            return s;
        } catch (Exception e) {
            logger.error("hexEncode编码错误！原因：" + e.getMessage());
            return null;
        }
    }
}

具体调用代码部分如下：

 static {
        try {
            Security.addProvider(SM4ClassLoaderUtil.getBouncyCastleProviderInstance());
        } catch (Exception e) {
            throw new RuntimeException(e.getMessage());
        }
    }

 //String hexKey = new String(Hex.encode(key.getBytes("UTF-8")));
   String hexKey = SM4ClassLoaderUtil.hexEncode(key);

这样，就可以根据不同的加密规则去调用不同的工具类就行了。

总结

jar包冲突的原因有很多，需要我们根据分析具体的原因去选择合适的解决方案。

最后，如果本篇文章对您有所帮助，可以评论或点赞支持一下哦，感谢感谢！