org.dromara.hutool.crypto.digest.DigesterFactory Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dromara.hutool.crypto.digest;
import org.dromara.hutool.crypto.SecureUtil;
import org.dromara.hutool.crypto.provider.GlobalProviderFactory;
import java.security.MessageDigest;
import java.security.Provider;
/**
* {@link Digester}创建简单工厂，用于生产{@link Digester}对象
* 参考Guava方式，工厂负责持有一个原始的{@link MessageDigest}对象，使用时优先通过clone方式创建对象，提高初始化性能。
*
* @author looly
*/
public class DigesterFactory {
/**
* 创建工厂，只使用JDK提供的算法
*
* @param algorithm 算法
* @return DigesterFactory
*/
public static DigesterFactory ofJdk(final String algorithm) {
return of(SecureUtil.createJdkMessageDigest(algorithm));
}
/**
* 创建工厂，使用{@link GlobalProviderFactory}找到的提供方。
*
* @param algorithm 算法
* @return DigesterFactory
*/
public static DigesterFactory of(final String algorithm) {
return of(SecureUtil.createMessageDigest(algorithm, null));
}
/**
* 创建工厂
*
* @param messageDigest {@link MessageDigest}，可以通过{@link SecureUtil#createMessageDigest(String, Provider)} 创建
* @return DigesterFactory
*/
public static DigesterFactory of(final MessageDigest messageDigest) {
return new DigesterFactory(messageDigest);
}
private final MessageDigest prototype;
private final boolean cloneSupport;
/**
* 构造
*
* @param messageDigest {@link MessageDigest}模板
*/
private DigesterFactory(final MessageDigest messageDigest) {
this.prototype = messageDigest;
this.cloneSupport = checkCloneSupport(messageDigest);
}
/**
* 创建{@link Digester}
*
* @return {@link Digester}
*/
public Digester createDigester() {
return new Digester(createMessageDigester());
}
/**
* 创建{@link MessageDigest}
*
* @return {@link MessageDigest}
*/
public MessageDigest createMessageDigester() {
if (cloneSupport) {
try {
return (MessageDigest) prototype.clone();
} catch (final CloneNotSupportedException ignore) {
// ignore
}
}
return SecureUtil.createJdkMessageDigest(prototype.getAlgorithm());
}
/**
* 检查{@link MessageDigest}对象是否支持clone方法
*
* @param messageDigest {@link MessageDigest}
* @return 是否支持clone方法
*/
private static boolean checkCloneSupport(final MessageDigest messageDigest) {
try {
messageDigest.clone();
return true;
} catch (final CloneNotSupportedException e) {
return false;
}
}
}