com.feilong.json.JavaToJsonConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
/*
* Copyright (C) 2008 feilong
*
* 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 com.feilong.json;
import java.util.Map;
import com.feilong.json.builder.JsonConfigBuilder;
import com.feilong.lib.json.processors.JsonValueProcessor;
import com.feilong.lib.json.processors.PropertyNameProcessor;
import com.feilong.lib.json.util.PropertyFilter;
/**
* java格式化成json的一些配置.
*
* @author feilong
* @see com.feilong.lib.json.JsonConfig
* @since 1.2.2
* @since 1.9.4 rename
*/
public class JavaToJsonConfig extends AbstractConfig{
/**
* 是否 mask 默认的敏感字符.
*
*
* 默认是 true, 表示会将默认的敏感字符({@link JsonConfigBuilder#SENSITIVE_WORDS_PROPERTY_NAMES}),格式化的时候,输出成 *******代替
*
*
* @see com.feilong.json.processor.SensitiveWordsJsonValueProcessor
* @see JsonConfigBuilder#SENSITIVE_WORDS_PROPERTY_NAMES
* @since 1.12.6
*/
private boolean isMaskDefaultSensitiveWords = true;
/**
* 是否忽略 null value 元素,默认 false,表示不忽略.
*
* 示例:
*
*
*
* 假设有bean 只有 2 个元素
*
*
*
* public class BeanIntIgnoreNull{
*
* private Integer age;
*
* private String name;
*
* //省略 setter getter
* }
*
* LOGGER.debug(JsonUtil.format(new BeanIntIgnoreNull(16, null)));
*
*
*
* 输出:
*
*
* {
"name": "",
"age": 16
}
*
*
* 如果需求不想要输出 null value 的元素,可以如此这般
*
*
*
* JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
* javaToJsonConfig.setIsIgnoreNullValueElement(true);
* LOGGER.debug(JsonUtil.format(new BeanIntIgnoreNull(16, null), javaToJsonConfig));
*
*
*
* 输出:
*
*
* {"age": 16}
*
*
* 并且如果两个元素都是 null 值
*
*
*
* JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
* javaToJsonConfig.setIsIgnoreNullValueElement(true);
*
* LOGGER.debug(JsonUtil.format(new BeanIntIgnoreNull(null, null), javaToJsonConfig));
*
*
*
* 输出:
*
*
* {}
*
*
*
*
* @since 2.0.0
*/
private boolean isIgnoreNullValueElement = false;
//---------------------------------------------------------------
/** 包含属性名称的数组. */
private String[] includes;
/**
* 指定属性名称使用的值修改处理器.
*
* 示例:
*
*
*
*
* User user = new User("feilong1", 24);
* user.setPassword("123456");
* user.setMoney(ConvertUtil.toBigDecimal("99999999.00"));
*
* Map{@code } propertyNameAndJsonValueProcessorMap = new HashMap{@code <>}();
* propertyNameAndJsonValueProcessorMap.put("password", new SensitiveWordsJsonValueProcessor());
* propertyNameAndJsonValueProcessorMap.put("money", new BigDecimalJsonValueProcessor());
*
* JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
* javaToJsonConfig.setPropertyNameAndJsonValueProcessorMap(propertyNameAndJsonValueProcessorMap);
*
* LOGGER.info(JsonUtil.format(user, javaToJsonConfig));
*
*
* 将会输出:
*
*
* {
* "password": "******",
* "age": 24,
* "name": "feilong1",
* "money": "99999999.00"
* }
*
*
*
*
* @see com.feilong.lib.json.processors.JsonValueProcessor
* @see com.feilong.json.processor.BigDecimalJsonValueProcessor
* @see com.feilong.json.processor.SensitiveWordsJsonValueProcessor
* @since 1.11.5 change no 通配符
*/
private Map propertyNameAndJsonValueProcessorMap;
/**
* 转成json的时候,对属性名字做特殊处理的控制器对映关系.
*
* 说明:
*
*
* 我们这边的代码
*
*
* public class CrmAddpointCommand implements Serializable{
*
* // 用户编码
* private String openId;
*
* // 渠道：Tmall - 天猫 JD - 京东
* private String consumptionChannel;
*
* // 淘宝/京东买家账号
* private String buyerId;
*
* // 电商订单编号
* private String orderCode;
*
* // setter getter
* }
*
*
*
* 符合标准的java代码规范,如果直接使用 {@link com.feilong.json.JsonUtil#format(Object)}
*
*
*
* public void testJsonTest(){
* CrmAddpointCommand crmAddpointCommand = new CrmAddpointCommand();
*
* crmAddpointCommand.setBuyerId("123456");
* crmAddpointCommand.setConsumptionChannel("feilongstore");
* crmAddpointCommand.setOpenId("feilong888888ky");
* crmAddpointCommand.setOrderCode("fl123456");
*
* LOGGER.debug(JsonUtil.format(crmAddpointCommand));
* }
*
*
*
* 输出结果:
*
*
* {
* "orderCode": "fl123456",
* "buyerId": "123456",
* "consumptionChannel": "feilongstore",
* "openId": "feilong888888ky"
* }
*
*
*
* 输出的属性大小写和 crmAddpointCommand 对象里面字段的大小写相同,但是对方接口要求首字符要大写:
*
*
* 
*
*
* 此时,你可以使用
*
*
*
* public void testJsonTest(){
* CrmAddpointCommand crmAddpointCommand = new CrmAddpointCommand();
*
* crmAddpointCommand.setBuyerId("123456");
* crmAddpointCommand.setConsumptionChannel("feilongstore");
* crmAddpointCommand.setOpenId("feilong888888ky");
* crmAddpointCommand.setOrderCode("fl123456");
*
* //---------------------------------------------------------------
*
* JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
*
* Map{@code , PropertyNameProcessor>} targetClassAndPropertyNameProcessorMap = newHashMap(1);
* targetClassAndPropertyNameProcessorMap.put(CrmAddpointCommand.class, CapitalizePropertyNameProcessor.INSTANCE);
*
* javaToJsonConfig.setJsonTargetClassAndPropertyNameProcessorMap(targetClassAndPropertyNameProcessorMap);
*
* LOGGER.debug(JsonUtil.format(crmAddpointCommand, javaToJsonConfig));
* }
*
*
* 输出结果:
*
*
* {
* "OrderCode": "fl123456",
* "BuyerId": "123456",
* "ConsumptionChannel": "feilongstore",
* "OpenId": "feilong888888ky"
* }
*
*
*
*
* @see json format 需要支持修改key的名字
* @since 1.9.3
*/
private Map, PropertyNameProcessor> jsonTargetClassAndPropertyNameProcessorMap;
//---------------------------------------------------------------
/**
* 过滤器, 对应{@link com.feilong.lib.json.JsonConfig#getJsonPropertyFilter()} ,
*
*
* - 如果返回true,该属性将会被过滤
*
*
* @since 3.0.10
*/
private PropertyFilter propertyFilter;
//---------------------------------------------------------------
/**
* The Constructor.
*/
public JavaToJsonConfig(){
}
/**
* Instantiates a new java to json config.
*
* @param isIgnoreNullValueElement
* the is ignore null value element
*/
public JavaToJsonConfig(boolean isIgnoreNullValueElement){
super();
this.isIgnoreNullValueElement = isIgnoreNullValueElement;
}
/**
* The Constructor.
*
* @param propertyNameAndJsonValueProcessorMap
* the property name and json value processor map
* @since 1.11.5 change no 通配符
*/
public JavaToJsonConfig(Map propertyNameAndJsonValueProcessorMap){
this.propertyNameAndJsonValueProcessorMap = propertyNameAndJsonValueProcessorMap;
}
/**
* The Constructor.
*
* @param excludes
* the excludes
* @param includes
* the includes
*/
public JavaToJsonConfig(String[] excludes, String[] includes){
this.excludes = excludes;
this.includes = includes;
}
//---------------------------------------------------------------
/**
* 获得 包含属性名称的数组.
*
* @return the 包含属性名称的数组
*/
public String[] getIncludes(){
return includes;
}
/**
* 设置 包含属性名称的数组.
*
* @param includes
* the new 包含属性名称的数组
* @since 1.8.5 change to Varargs
*/
public void setIncludes(String...includes){
this.includes = includes;
}
//---------------------------------------------------------------
/**
* 指定属性名称使用的值修改处理器.
*
* 示例:
*
*
*
*
* User user = new User("feilong1", 24);
* user.setPassword("123456");
* user.setMoney(ConvertUtil.toBigDecimal("99999999.00"));
*
* Map{@code } propertyNameAndJsonValueProcessorMap = new HashMap{@code <>}();
* propertyNameAndJsonValueProcessorMap.put("password", new SensitiveWordsJsonValueProcessor());
* propertyNameAndJsonValueProcessorMap.put("money", new BigDecimalJsonValueProcessor());
*
* JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
* javaToJsonConfig.setPropertyNameAndJsonValueProcessorMap(propertyNameAndJsonValueProcessorMap);
*
* LOGGER.info(JsonUtil.format(user, javaToJsonConfig));
*
*
* 将会输出:
*
*
* {
* "password": "******",
* "age": 24,
* "name": "feilong1",
* "money": "99999999.00"
* }
*
*
*
*
* @return the propertyNameAndJsonValueProcessorMap
* @see com.feilong.lib.json.processors.JsonValueProcessor
* @see com.feilong.json.processor.BigDecimalJsonValueProcessor
* @see com.feilong.json.processor.SensitiveWordsJsonValueProcessor
* @since 1.11.5 change no 通配符
*/
public Map getPropertyNameAndJsonValueProcessorMap(){
return propertyNameAndJsonValueProcessorMap;
}
/**
* 指定属性名称使用的值修改处理器.
*
* 示例:
*
*
*
*
* User user = new User("feilong1", 24);
* user.setPassword("123456");
* user.setMoney(ConvertUtil.toBigDecimal("99999999.00"));
*
* Map{@code } propertyNameAndJsonValueProcessorMap = new HashMap{@code <>}();
* propertyNameAndJsonValueProcessorMap.put("password", new SensitiveWordsJsonValueProcessor());
* propertyNameAndJsonValueProcessorMap.put("money", new BigDecimalJsonValueProcessor());
*
* JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
* javaToJsonConfig.setPropertyNameAndJsonValueProcessorMap(propertyNameAndJsonValueProcessorMap);
*
* LOGGER.info(JsonUtil.format(user, javaToJsonConfig));
*
*
* 将会输出:
*
*
* {
* "password": "******",
* "age": 24,
* "name": "feilong1",
* "money": "99999999.00"
* }
*
*
*
*
* @param propertyNameAndJsonValueProcessorMap
* the propertyNameAndJsonValueProcessorMap to set
* @see com.feilong.lib.json.processors.JsonValueProcessor
* @see com.feilong.json.processor.BigDecimalJsonValueProcessor
* @see com.feilong.json.processor.SensitiveWordsJsonValueProcessor
* @since 1.11.5 change no 通配符
*/
public void setPropertyNameAndJsonValueProcessorMap(Map propertyNameAndJsonValueProcessorMap){
this.propertyNameAndJsonValueProcessorMap = propertyNameAndJsonValueProcessorMap;
}
//---------------------------------------------------------------
/**
* 转成json的时候,对属性名字做特殊处理的控制器对映关系.
*
* 说明:
*
*
* 我们这边的代码
*
*
* public class CrmAddpointCommand implements Serializable{
*
* // 用户编码
* private String openId;
*
* // 渠道：Tmall - 天猫 JD - 京东
* private String consumptionChannel;
*
* // 淘宝/京东买家账号
* private String buyerId;
*
* // 电商订单编号
* private String orderCode;
*
* // setter getter
* }
*
*
*
* 符合标准的java代码规范,如果直接使用 {@link com.feilong.json.JsonUtil#format(Object)}
*
*
*
* public void testJsonTest(){
* CrmAddpointCommand crmAddpointCommand = new CrmAddpointCommand();
*
* crmAddpointCommand.setBuyerId("123456");
* crmAddpointCommand.setConsumptionChannel("feilongstore");
* crmAddpointCommand.setOpenId("feilong888888ky");
* crmAddpointCommand.setOrderCode("fl123456");
*
* LOGGER.debug(JsonUtil.format(crmAddpointCommand));
* }
*
*
*
* 输出结果:
*
*
* {
* "orderCode": "fl123456",
* "buyerId": "123456",
* "consumptionChannel": "feilongstore",
* "openId": "feilong888888ky"
* }
*
*
*
* 输出的属性大小写和 crmAddpointCommand 对象里面字段的大小写相同,但是对方接口要求首字符要大写:
*
*
*
*
*
* 此时,你可以使用
*
*
*
* public void testJsonTest(){
* CrmAddpointCommand crmAddpointCommand = new CrmAddpointCommand();
*
* crmAddpointCommand.setBuyerId("123456");
* crmAddpointCommand.setConsumptionChannel("feilongstore");
* crmAddpointCommand.setOpenId("feilong888888ky");
* crmAddpointCommand.setOrderCode("fl123456");
*
* //---------------------------------------------------------------
*
* JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
*
* Map{@code , PropertyNameProcessor>} targetClassAndPropertyNameProcessorMap = newHashMap(1);
* targetClassAndPropertyNameProcessorMap.put(CrmAddpointCommand.class, CapitalizePropertyNameProcessor.INSTANCE);
*
* javaToJsonConfig.setJsonTargetClassAndPropertyNameProcessorMap(targetClassAndPropertyNameProcessorMap);
*
* LOGGER.debug(JsonUtil.format(crmAddpointCommand, javaToJsonConfig));
* }
*
*
* 输出结果:
*
*
* {
* "OrderCode": "fl123456",
* "BuyerId": "123456",
* "ConsumptionChannel": "feilongstore",
* "OpenId": "feilong888888ky"
* }
*
*
*
*
* @return the 转成json的时候,对属性名字做特殊处理的控制器对映关系
* @see json format 需要支持修改key的名字
* @since 1.9.3
*/
public Map, PropertyNameProcessor> getJsonTargetClassAndPropertyNameProcessorMap(){
return jsonTargetClassAndPropertyNameProcessorMap;
}
/**
* 转成json的时候,对属性名字做特殊处理的控制器对映关系.
*
* 说明:
*
*
* 我们这边的代码
*
*
* public class CrmAddpointCommand implements Serializable{
*
* // 用户编码
* private String openId;
*
* // 渠道：Tmall - 天猫 JD - 京东
* private String consumptionChannel;
*
* // 淘宝/京东买家账号
* private String buyerId;
*
* // 电商订单编号
* private String orderCode;
*
* // setter getter
* }
*
*
*
* 符合标准的java代码规范,如果直接使用 {@link com.feilong.json.JsonUtil#format(Object)}
*
*
*
* public void testJsonTest(){
* CrmAddpointCommand crmAddpointCommand = new CrmAddpointCommand();
*
* crmAddpointCommand.setBuyerId("123456");
* crmAddpointCommand.setConsumptionChannel("feilongstore");
* crmAddpointCommand.setOpenId("feilong888888ky");
* crmAddpointCommand.setOrderCode("fl123456");
*
* LOGGER.debug(JsonUtil.format(crmAddpointCommand));
* }
*
*
*
* 输出结果:
*
*
* {
* "orderCode": "fl123456",
* "buyerId": "123456",
* "consumptionChannel": "feilongstore",
* "openId": "feilong888888ky"
* }
*
*
*
* 输出的属性大小写和 crmAddpointCommand 对象里面字段的大小写相同,但是对方接口要求首字符要大写:
*
*
*
*
*
* 此时,你可以使用
*
*
*
* public void testJsonTest(){
* CrmAddpointCommand crmAddpointCommand = new CrmAddpointCommand();
*
* crmAddpointCommand.setBuyerId("123456");
* crmAddpointCommand.setConsumptionChannel("feilongstore");
* crmAddpointCommand.setOpenId("feilong888888ky");
* crmAddpointCommand.setOrderCode("fl123456");
*
* //---------------------------------------------------------------
*
* JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
*
* Map{@code , PropertyNameProcessor>} targetClassAndPropertyNameProcessorMap = newHashMap(1);
* targetClassAndPropertyNameProcessorMap.put(CrmAddpointCommand.class, CapitalizePropertyNameProcessor.INSTANCE);
*
* javaToJsonConfig.setJsonTargetClassAndPropertyNameProcessorMap(targetClassAndPropertyNameProcessorMap);
*
* LOGGER.debug(JsonUtil.format(crmAddpointCommand, javaToJsonConfig));
* }
*
*
* 输出结果:
*
*
* {
* "OrderCode": "fl123456",
* "BuyerId": "123456",
* "ConsumptionChannel": "feilongstore",
* "OpenId": "feilong888888ky"
* }
*
*
*
*
* @param jsonTargetClassAndPropertyNameProcessorMap
* the new 转成json的时候,对属性名字做特殊处理的控制器对映关系
* @see json format 需要支持修改key的名字
* @since 1.9.3
*/
public void setJsonTargetClassAndPropertyNameProcessorMap(
Map, PropertyNameProcessor> jsonTargetClassAndPropertyNameProcessorMap){
this.jsonTargetClassAndPropertyNameProcessorMap = jsonTargetClassAndPropertyNameProcessorMap;
}
//---------------------------------------------------------------
/**
* 是否 mask 默认的敏感字符.
*
*
* 默认是 true, 表示会将默认的敏感字符({@link JsonConfigBuilder#SENSITIVE_WORDS_PROPERTY_NAMES}),格式化的时候,输出成 *******代替
*
*
* @return the isMaskDefaultSensitiveWords
* @see com.feilong.json.processor.SensitiveWordsJsonValueProcessor
* @see JsonConfigBuilder#SENSITIVE_WORDS_PROPERTY_NAMES
* @since 1.12.6
*/
public boolean getIsMaskDefaultSensitiveWords(){
return isMaskDefaultSensitiveWords;
}
/**
* 是否 mask 默认的敏感字符.
*
*
* 默认是 true, 表示会将默认的敏感字符({@link JsonConfigBuilder#SENSITIVE_WORDS_PROPERTY_NAMES}),格式化的时候,输出成 *******代替
*
*
* @param isMaskDefaultSensitiveWords
* the new 是否 mask 默认的敏感字符
* @see com.feilong.json.processor.SensitiveWordsJsonValueProcessor
* @see JsonConfigBuilder#SENSITIVE_WORDS_PROPERTY_NAMES
* @since 1.12.6
*/
public void setIsMaskDefaultSensitiveWords(boolean isMaskDefaultSensitiveWords){
this.isMaskDefaultSensitiveWords = isMaskDefaultSensitiveWords;
}
//---------------------------------------------------------------
/**
* 是否忽略 null value 元素,默认 false,表示不忽略.
*
* 示例:
*
*
*
* 假设有bean 只有 2 个元素
*
*
*
* public class BeanIntIgnoreNull{
*
* private Integer age;
*
* private String name;
*
* //省略 setter getter
* }
*
* LOGGER.debug(JsonUtil.format(new BeanIntIgnoreNull(16, null)));
*
*
*
* 输出:
*
*
* {
"name": "",
"age": 16
}
*
*
* 如果需求不想要输出 null value 的元素,可以如此这般
*
*
*
* JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
* javaToJsonConfig.setIsIgnoreNullValueElement(true);
* LOGGER.debug(JsonUtil.format(new BeanIntIgnoreNull(16, null), javaToJsonConfig));
*
*
*
* 输出:
*
*
* {"age": 16}
*
*
* 并且如果两个元素都是 null 值
*
*
*
* JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
* javaToJsonConfig.setIsIgnoreNullValueElement(true);
*
* LOGGER.debug(JsonUtil.format(new BeanIntIgnoreNull(null, null), javaToJsonConfig));
*
*
*
* 输出:
*
*
* {}
*
*
*
*
* @return the isIgnoreNullValueElement
* @since 2.0.0
*/
public boolean getIsIgnoreNullValueElement(){
return isIgnoreNullValueElement;
}
/**
* 是否忽略 null value 元素,默认 false,表示不忽略.
*
* 示例:
*
*
*
* 假设有bean 只有 2 个元素
*
*
*
* public class BeanIntIgnoreNull{
*
* private Integer age;
*
* private String name;
*
* //省略 setter getter
* }
*
* LOGGER.debug(JsonUtil.format(new BeanIntIgnoreNull(16, null)));
*
*
*
* 输出:
*
*
* {
"name": "",
"age": 16
}
*
*
* 如果需求不想要输出 null value 的元素,可以如此这般
*
*
*
* JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
* javaToJsonConfig.setIsIgnoreNullValueElement(true);
* LOGGER.debug(JsonUtil.format(new BeanIntIgnoreNull(16, null), javaToJsonConfig));
*
*
*
* 输出:
*
*
* {"age": 16}
*
*
* 并且如果两个元素都是 null 值
*
*
*
* JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
* javaToJsonConfig.setIsIgnoreNullValueElement(true);
*
* LOGGER.debug(JsonUtil.format(new BeanIntIgnoreNull(null, null), javaToJsonConfig));
*
*
*
* 输出:
*
*
* {}
*
*
*
*
* @param isIgnoreNullValueElement
* the isIgnoreNullValueElement to set
* @since 2.0.0
*/
public void setIsIgnoreNullValueElement(boolean isIgnoreNullValueElement){
this.isIgnoreNullValueElement = isIgnoreNullValueElement;
}
/**
* 过滤器, 对应{@link com.feilong.lib.json.JsonConfig#getJsonPropertyFilter()} ,
*
*
* - 如果返回true,该属性将会被过滤
*
*
* @return the propertyFilter
* @since 3.0.10
*/
public PropertyFilter getPropertyFilter(){
return propertyFilter;
}
/**
* 过滤器, 对应{@link com.feilong.lib.json.JsonConfig#getJsonPropertyFilter()} ,
*
*
* - 如果返回true,该属性将会被过滤
*
*
* @param propertyFilter
* the propertyFilter to set
* @since 3.0.10
*/
public void setPropertyFilter(PropertyFilter propertyFilter){
this.propertyFilter = propertyFilter;
}
}