jpa使用uuid策略后無法手動設置id的問題及解決

更新時間：2024年08月12日 09:12:09 作者：流年ln

這篇文章主要介紹了jpa使用uuid策略后無法手動設置id的問題及解決,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

jpa使用uuid策略后無法手動設置id

實體對象定義如下：

@Data
@Entity
@Table(name = "sys_user")
public class UserDO {

	/** 用戶id */
	@Id
	@GenericGenerator(name = "uuid", strategy = "org.hibernate.id.UUIDGenerator")
	@GeneratedValue(generator = "uuid")
	@Column(length = 36, nullable = false)
	private String userId;
	....
}

調用jpa的save方法，即使手動設置了id，手動設置的這個id也會被覆蓋。

要求

當用戶手動設置了id，以用戶設置的id為準，否則使用uuid

解決方案

使用自定義id生成策略，判斷id非空

import cn.hutool.core.util.StrUtil;
import lombok.extern.slf4j.Slf4j;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.id.UUIDGenerator;

import javax.persistence.Id;
import java.io.Serializable;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

/**
 * 自定義uuid生成策略, 擴展 {@link org.hibernate.id.UUIDGenerator}
 * 當用戶設置了id，以用戶設置的id為主，為空則生成uuid
 * {@link javax.persistence.Id} 注解的字段只處理第一個
 *
 * @author qiudw
 * @date 7/7/2023
 */
@Slf4j
public class CustomerUuidGenerator extends UUIDGenerator {

	@Override
	public Serializable generate(SharedSessionContractImplementor session, Object obj) {
		Class<?> clazz = obj.getClass();
		log.debug("generate id class: {}", clazz.getName());
		Field[] fields = clazz.getDeclaredFields();
		try {
			for (Field field : fields) {
				Id idAnnotation = field.getAnnotation(Id.class);
				if (idAnnotation == null) {
					continue;
				}
				String fieldName = field.getName();
				log.debug("field name: {}", fieldName);
				String getMethodName = generateGetMethodName(fieldName);
				log.debug("get method name: {}", getMethodName);
				Method declaredMethod = clazz.getDeclaredMethod(getMethodName);
				String idValue = (String) declaredMethod.invoke(obj);
				if (StrUtil.isNotBlank(idValue)) {
					log.debug("use set value: {}", idValue);
					return idValue;
				}
			}
		} catch (NoSuchMethodException e) {
			log.error("no such method", e);
		} catch (InvocationTargetException | IllegalAccessException e) {
			log.error("invoke exception", e);
		}

		return super.generate(session, obj);
	}

	/**
	 * 生成get和set的方法名稱
	 * type + 首字母大寫(fieldName)
	 *
	 * @param fieldName userId
	 * @return type = set, fieldName = userId, 返回 setUserId
	 */
	private String generateGetMethodName(String fieldName) {
		return "get" + fieldName.substring(0, 1).toUpperCase() + fieldName.substring(1);
	}

}

實體對象使用自定的策略

@Data
@Entity
@Table(name = "sys_user")
public class UserDO {

	/** 用戶id */
	@Id
	@GenericGenerator(name = "uuid", strategy = "com.user.CustomerUuidGenerator")
	@GeneratedValue(generator = "uuid")
	@Column(length = 36, nullable = false)
	private String userId;
	....
}

現(xiàn)在可以手動設置id了