自定义注解,用于标记必输属性名
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* <pre>
* 标识某个字段是否是必填的
* </pre>
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Required {
}
工具类:
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
public class BeanUtils {
private static Logger log = LoggerFactory.getLogger(BeanUtils.class);
/**
* 检查bean里标记为@Required的field是否为空,为空则抛异常
*/
public static void checkRequiredFields(Object bean) throws Exception {
if (bean == null) {
throw new Exception("对象为空");
}
List<String> requiredFields = new ArrayList<>();
List<Field> fields = new ArrayList<>(Arrays.asList(bean.getClass().getDeclaredFields()));
fields.addAll(Arrays.asList(bean.getClass().getSuperclass().getDeclaredFields()));
for (Field field : fields) {
try {
boolean isAccessible = field.isAccessible();
field.setAccessible(true);
if (field.isAnnotationPresent(Required.class)) {
// 两种情况,一种是值为null,
// 另外一种情况是类型为字符串,但是字符串内容为空的,都认为是没有提供值
boolean isRequiredMissing = field.get(bean) == null
|| (field.get(bean) instanceof String
&& StringUtils.isBlank(field.get(bean).toString())
);
if (isRequiredMissing) {
requiredFields.add(field.getName());
}
}
field.setAccessible(isAccessible);
} catch (SecurityException | IllegalArgumentException
| IllegalAccessException e) {
log.error(e.getMessage(), e);
}
}
if (!requiredFields.isEmpty()) {
throw new Exception("必填字段 " + requiredFields + " 必须提供值");
}
}
}
实体类:
import com.alibaba.fastjson.annotation.JSONField;
import com.vlockers.short_msg_push_service.common.annotation.Required;
import lombok.Data;
@Data
public class ShortMsgPushRequest {
@Required
@JSONField(name = "tel")
private String tel;
@Required
@JSONField(name = "type")
private Integer type;
@Required
@JSONField(name = "attach")
private String attach;
}