org.onetwo.dbm.annotation.DbmJsonField Maven / Gradle / Ivy

Go to download
package org.onetwo.dbm.annotation;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.onetwo.dbm.mapping.converter.JsonFieldValueConverter;

import lombok.AllArgsConstructor;
import lombok.Getter;

/***
 * 标注字段为json字段
 * @author way
 *
 */
@Target({FIELD, METHOD})
@Retention(RetentionPolicy.RUNTIME)
@DbmFieldConvert(converterClass=JsonFieldValueConverter.class)
public @interface DbmJsonField {
	
	/***
	 * 序列化json的时候是否保存类型信息
	 * @author weishao zeng
	 * @return
	 */
	boolean storeTyping() default false;
	/***
	 * 开启此属性后，从json转为Java时，会根据json里是否包含@class关键字判断是否需要使用Typing Mapper
	 * 主要用于兼容类似下面的情况：开始未启用storeTyping，后来又启用了storeTyping属性，或相反。
	 * @return
	 */
	boolean smartyParse() default false;
	
	/***
	 * 保存到数据时，可转换的类型
	 * @author weishao zeng
	 * @return
	 */
	JsonConvertibleTypes convertibleJavaType() default JsonConvertibleTypes.STRING;
	
	/****
	 * 当映射的类型为泛型容器(Collection)时，使用此属性指定容器的值类型
	 * @author weishao zeng
	 * @return
	 */
	Class valueType() default void.class;
	
	@AllArgsConstructor
	public enum JsonConvertibleTypes {
		STRING(String.class),
		BYTE_ARRAY(byte[].class);
		
		@Getter
		private Class javaType;
	}

}