org.dromara.hutool.setting.AbsSetting 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.setting;
import org.dromara.hutool.core.bean.BeanUtil;
import org.dromara.hutool.core.bean.copier.CopyOptions;
import org.dromara.hutool.core.bean.copier.ValueProvider;
import org.dromara.hutool.core.func.LambdaInfo;
import org.dromara.hutool.core.func.LambdaUtil;
import org.dromara.hutool.core.func.SerFunction;
import org.dromara.hutool.core.lang.getter.GroupedTypeGetter;
import org.dromara.hutool.core.lang.getter.TypeGetter;
import org.dromara.hutool.core.reflect.ConstructorUtil;
import org.dromara.hutool.core.text.StrUtil;
import org.dromara.hutool.core.text.split.SplitUtil;
import org.dromara.hutool.core.util.ObjUtil;
import java.io.Serializable;
import java.lang.reflect.Type;
/**
* Setting抽象类
*
* @author Looly
*/
public abstract class AbsSetting implements TypeGetter,
GroupedTypeGetter, Serializable {
private static final long serialVersionUID = 6200156302595905863L;
/**
* 数组类型值默认分隔符
*/
public final static String DEFAULT_DELIMITER = StrUtil.COMMA;
/**
* 默认分组
*/
public final static String DEFAULT_GROUP = StrUtil.EMPTY;
@Override
public Object getObj(final CharSequence key, final Object defaultValue) {
return ObjUtil.defaultIfNull(getObjByGroup(key, DEFAULT_GROUP), defaultValue);
}
/**
* 根据lambda的方法引用，获取
*
* @param func 方法引用
* @param 参数类型
* @param 返回值类型
* @return 获取表达式对应属性和返回的对象
*/
public T get(final SerFunction func) {
final LambdaInfo lambdaInfo = LambdaUtil.resolve(func);
return get(lambdaInfo.getFieldName(), lambdaInfo.getReturnType());
}
/**
* 获得字符串类型值，如果字符串为{@code null}或者""返回默认值
*
* @param key KEY
* @param group 分组
* @param defaultValue 默认值
* @return 值，如果字符串为{@code null}或者""返回默认值
*/
public String getByGroupNotEmpty(final String key, final String group, final String defaultValue) {
final String value = getStrByGroup(key, group);
return StrUtil.defaultIfEmpty(value, defaultValue);
}
// --------------------------------------------------------------- Get string array
/**
* 获得数组型
*
* @param key 属性名
* @return 属性值
*/
public String[] getStrs(final String key) {
return getStrs(key, null);
}
/**
* 获得数组型
*
* @param key 属性名
* @param defaultValue 默认的值
* @return 属性值
*/
public String[] getStrs(final CharSequence key, final String[] defaultValue) {
String[] value = getStrsByGroup(key, null);
if (null == value) {
value = defaultValue;
}
return value;
}
/**
* 获得数组型默认逗号分隔
* 若配置文件中键值对类似于：
*
* a = 1,2,3,4
*
* 则获取结果为：[1, 2, 3, 4]
*
* @param key 属性名
* @param group 分组名
* @return 属性值
*/
public String[] getStrsByGroup(final CharSequence key, final CharSequence group) {
return getStrsByGroup(key, group, DEFAULT_DELIMITER);
}
/**
* 获得数组型，可自定义分隔符
* 假定分隔符为逗号，若配置文件中键值对类似于：
*
* a = 1,2,3,4
*
* 则获取结果为：[1, 2, 3, 4]
*
* @param key 属性名
* @param group 分组名
* @param delimiter 分隔符
* @return 属性值
*/
public String[] getStrsByGroup(final CharSequence key, final CharSequence group, final CharSequence delimiter) {
final String value = getStrByGroup(key, group);
if (StrUtil.isBlank(value)) {
return null;
}
return SplitUtil.splitToArray(value, delimiter);
}
/**
* 将setting中的键值关系映射到对象中，原理是调用对象对应的set方法
* 只支持基本类型的转换
*
* @param Bean类型
* @param group 分组
* @param bean Bean对象
* @return Bean
*/
public T toBean(final CharSequence group, final T bean) {
return BeanUtil.fillBean(bean, new ValueProvider() {
@Override
public Object value(final String key, final Type valueType) {
return getObjByGroup(key, group);
}
@Override
public boolean containsKey(final String key) {
return null != getObjByGroup(key, group);
}
}, CopyOptions.of());
}
/**
* 将setting中的键值关系映射到对象中，原理是调用对象对应的set方法
* 只支持基本类型的转换
*
* @param Bean类型
* @param group 分组
* @param beanClass Bean类型
* @return Bean
* @since 5.0.6
*/
public T toBean(final CharSequence group, final Class beanClass) {
return toBean(group, ConstructorUtil.newInstanceIfPossible(beanClass));
}
/**
* 将setting中的键值关系映射到对象中，原理是调用对象对应的set方法
* 只支持基本类型的转换
*
* @param bean类型
* @param bean Bean
* @return Bean
*/
public T toBean(final T bean) {
return toBean(null, bean);
}
/**
* 将setting中的键值关系映射到对象中，原理是调用对象对应的set方法
* 只支持基本类型的转换
*
* @param bean类型
* @param beanClass Bean类型
* @return Bean
* @since 5.0.6
*/
public T toBean(final Class beanClass) {
return toBean(null, beanClass);
}
}