SpringBoot 接口对枚举类型的入参以及出参的转换处理

本文详细介绍了如何在SpringMVC项目中使用枚举类型,包括BaseEnum接口的定义、枚举的序列化与反序列化、以及自定义转换工厂以处理不同类型的枚举参数。展示了如何通过代码实现在接口出参和入参中使用0和1映射性别枚举。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1、在项目中使用枚举类型

一般我们在项目中,设置表的类型字段,都是用int存储,用0、1、2…代表不同类型的含义。
以性别字段为例:
数据库表字段设计为integer:

CREATE TABLE t_user_info
(
	...
    sex INT NOT NULL COMMENT '性别,0-女,1-男'
    ...
);

实体成员变量设计为枚举:

public class UserInfoEntity extends BaseField {
	...
    /** 性别,0-女,1-男 */
    private Sex sex;
    ...
}

@Getter
public enum Sex implements BaseEnum {
    woman(0, "女"), man(1, "男");

    @EnumValue //标记数据库存的值是sex
    private Integer code;

    private String desc;

    Sex(int code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    public String getStrCode() {
        return code.toString();
    }
}

2、不做任何处理的演示效果

如果我们不做任何额外处理,当使用Sex枚举作为出入参时。只能返回manwoman或用manwoman作为参数。

2.1、接口出参

封装出参实体中sex成员变量类型为Sex枚举,则出参为:manwoman
在这里插入图片描述

2.2、接口入参

若是使用Sex枚举类型接收请求参数,不论是从接口get请求url中获取,还是使用构造实体接收post请求参数。都只能用manwoman作为参数,如果使用0或1作为参数,则无法正确被转换为Sex枚举。但是在开发过程中前端下拉选选项一般都与0,1,2…相对应。
在这里插入图片描述

在这里插入图片描述

3、用枚举的code作为参数和返回值

以上面的Sex枚举为例子,我希望在返回sex字段时,用0和1作为返回值,并且希望能用0和1映射男和女作为接口入参。该如何实现呢?

3.1 代码案例

3.1.1、定义枚举基础接口BaseEnum,每个枚举都实现该接口

/**
 * 枚举基础接口
 * 注意:不要构造枚举name和code相互交叉使用的枚举,否则在进行转换时将获取意外的结果。例如:
 *public enum Sex2 implements BaseEnum {
 *     woman("man", "女"), man("woman", "男");
 *
 *     private String code;
 *     private String desc;
 *
 *     Sex2(String code, String desc) {
 *         this.code = code;
 *         this.desc = desc;
 *     }
 *     public String getStrCode() {
 *         return code;
 *     }
 * }
 *
 * 若是这种则是可以的:woman("woman", "女"), man("man", "男");
 */
public interface BaseEnum {

    /**
     * 根据枚举值或名称从枚举类型type中获取枚举对象
     */
    public static <T extends BaseEnum> T getEnum(Class<T> type, Object codeOrName) {
        T[] enums = type.getEnumConstants();
        for (T em : enums) {
            if (em.getStrCode().equals(codeOrName.toString()) || em.name().equals(codeOrName.toString())) {
                return em;
            }
        }
        return null;
    }

    /**
     * 获取枚举值的字符串code
     *
     * @return 编码
     */
    String getStrCode();

    /**
     * 获取枚举名称
     *
     * @return 名称
     */
    String name();
}

3.1.2、性别Sex枚举并实现接口BaseEnum

import com.baomidou.mybatisplus.annotation.EnumValue;
import lombok.Getter;

@Getter
public enum Sex implements BaseEnum {
    woman(0, "女"), man(1, "男");

    @EnumValue //标记数据库存的值是sex
    private Integer code;
    private String desc;
	
    Sex(int code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    public String getStrCode() {
        return code.toString();
    }
}

3.1.3、定义BaseEnum枚举接口序列化

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.study.enums.BaseEnum;
import java.io.IOException;

/**
 * BaseEnum 序列化
 */
public class BaseEnumSerializer extends JsonSerializer<BaseEnum> {
    @Override
    public void serialize(BaseEnum value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeNumber(value.getStrCode());
        // 增加一个字段,格式为【枚举类名称+Text】,存储枚举的name
        gen.writeStringField(gen.getOutputContext().getCurrentName() + "Text", value.name());
    }
}

3.1.4、自定义Enum枚举接口反序列化

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonNode;
import com.study.enums.BaseEnum;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.BeanUtils;
import java.io.IOException;

/**
 * BaseEnum反序列化
 */
@Slf4j
public class BaseEnumDeserializer extends JsonDeserializer<Enum> {
    @Override
    public Enum deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        JsonNode node = p.getCodec().readTree(p);
        String currentName = p.currentName();
        Object currentValue = p.getCurrentValue();
        Class findPropertyType = BeanUtils.findPropertyType(currentName, currentValue.getClass());
        if (findPropertyType == null) {
            log.info("在" + currentValue.getClass() + "实体类中找不到" + currentName + "字段");
            return null;
        }

        String asText = node.asText();
        if (StringUtils.isBlank(asText)) {
            return null;
        }

        if (BaseEnum.class.isAssignableFrom(findPropertyType)) {
            BaseEnum valueOf = null;
            if (StringUtils.isNotBlank(asText)) {
                valueOf = BaseEnum.getEnum(findPropertyType, asText);
            }
            if (valueOf != null) {
                return (Enum) valueOf;
            }
        }
        return Enum.valueOf(findPropertyType, asText);
    }
}

3.1.5、配置自定义的BaseEnum类的序列化和Enum类的反序列

配置Jackson在序列化BaseEnum和反序列化Enum时,使用我们自己定义的BaseEnumSerializer、EnumDeserializer进行处理。

因为Spring boot使用的是Jackson序列化接口出参的,所以若我们自定定义的枚举若是都实现了BaseEnum接口,那么就会调用BaseEnumSerializer序列化枚举对象,达到预期的效果。

package com.study.config;

import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import com.study.enums.BaseEnum;
import com.study.serializer.EnumDeserializer;
import com.study.serializer.BaseEnumSerializer;
import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.TimeZone;

/**
 * 加载baseEnum 构建bean定义,初始化Spring容器。
 */
@Configuration
public class JacksonConfig {
    // JacksonConfig EnumBeanConfig
    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jacksonObjectMapperCustomization() {
        BaseEnumSerializer baseEnumSerializer = new BaseEnumSerializer();
        EnumDeserializer enumDeserializer = new EnumDeserializer();
        return jacksonObjectMapperBuilder -> jacksonObjectMapperBuilder.timeZone(TimeZone.getDefault())
                // 配置Jackson在序列化BaseEnum和反序列化Enum时,使用我们自己定义的BaseEnumSerializer、EnumDeserializer进行处理
                .serializerByType(BaseEnum.class, baseEnumSerializer)
                .deserializerByType(Enum.class, enumDeserializer);
    }
}

3.1.6、配置类型转换工厂IntegerCodeToEnumConverterFactory和StringCodeToEnumConverterFactory

作用是当我们使用枚举类型接收接口入参时,会根据请求参数是Integer或者String调用各自的转换器转为BaseEnum枚举类型

import com.study.converters.IntegerToEnumConverter;
import com.study.enums.BaseEnum;
import org.springframework.core.convert.converter.Converter;
import org.springframework.core.convert.converter.ConverterFactory;
import java.util.HashMap;
import java.util.Map;

/**
 * 枚举 转化器工厂类
 * 将Integer类型的参数转换为BaseEnum类型枚举对象
 * 参考:org.springframework.core.convert.support.IntegerToEnumConverterFactory
 */
public class IntegerCodeToEnumConverterFactory implements ConverterFactory<Integer, BaseEnum> {
    private static final Map<Class, Converter> CONVERTERS = new HashMap<>();

    /**
     * 获取一个从 Integer 转化为 T 的转换器,T 是一个泛型,有多个实现
     *
     * @param targetType 转换后的类型
     * @return 返回一个转化器
     */
    @Override
    public <T extends BaseEnum> Converter<Integer, T> getConverter(Class<T> targetType) {
        Converter<Integer, T> converter = CONVERTERS.get(targetType);
        if (converter == null) {
            converter = new IntegerToEnumConverter<>(targetType);
            CONVERTERS.put(targetType, converter);
        }
        return converter;
    }
}
import cn.hutool.core.util.ObjectUtil;
import com.study.enums.BaseEnum;
import org.springframework.core.convert.converter.Converter;
import java.util.HashMap;
import java.util.Map;

/**
 * Integer类型参数枚举 转化器
 *
 * @param <T>
 */
public class IntegerToEnumConverter<T extends BaseEnum> implements Converter<Integer, T> {
    private Map<String, T> enumMap = new HashMap<>();

    public IntegerToEnumConverter(Class<T> enumType) {
        T[] enums = enumType.getEnumConstants();
        for (T e : enums) {
            enumMap.put(e.getStrCode(), e);
        }
    }

    @Override
    public T convert(Integer source) {
        T t = enumMap.get(source);
        if (ObjectUtil.isNull(t)) {
            throw new IllegalArgumentException("无法匹配对应的枚举类型");
        }
        return t;
    }
}
import com.study.converters.StringToEnumConverter;
import com.study.enums.BaseEnum;
import org.springframework.core.convert.converter.Converter;
import org.springframework.core.convert.converter.ConverterFactory;
import java.util.HashMap;
import java.util.Map;

/**
 * 枚举 转化器工厂类
 * 将String类型的参数转换为BaseEnum类型枚举对象
 * 参考:org.springframework.core.convert.support.StringToEnumConverterFactory
 */
public class StringCodeToEnumConverterFactory implements ConverterFactory<String, BaseEnum> {
    private static final Map<Class, Converter> CONVERTERS = new HashMap<>();

    /**
     * 获取一个从 Integer 转化为 T 的转换器,T 是一个泛型,有多个实现
     *
     * @param targetType 转换后的类型
     * @return 返回一个转化器
     */
    @Override
    public <T extends BaseEnum> Converter<String, T> getConverter(Class<T> targetType) {
        Converter<String, T> converter = CONVERTERS.get(targetType);
        if (converter == null) {
            converter = new StringToEnumConverter<>(targetType);
            CONVERTERS.put(targetType, converter);
        }
        return converter;
    }
}
import cn.hutool.core.util.ObjectUtil;
import com.study.enums.BaseEnum;
import org.springframework.core.convert.converter.Converter;
import java.util.HashMap;
import java.util.Map;

/**
 * String类型参数枚举 转化器
 *
 * @param <T>
 */
public class StringToEnumConverter<T extends BaseEnum> implements Converter<String, T> {
    private final Map<String, T> enumMap = new HashMap<>();

    public StringToEnumConverter(Class<T> enumType) {
        T[] enums = enumType.getEnumConstants();
        for (T e : enums) {
            enumMap.put(e.getStrCode(), e);
            enumMap.put(e.name(), e);
        }
    }

    @Override
    public T convert(String source) {
        T t = enumMap.get(source);
        if (ObjectUtil.isNull(t)) {
            throw new IllegalArgumentException("无法匹配对应的枚举类型");
        }
        return t;
    }
}

3.1.7、将转换工厂注册到Spring MVC中

import com.study.converters.factory.IntegerCodeToEnumConverterFactory;
import com.study.converters.factory.StringCodeToEnumConverterFactory;
import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfigurer implements WebMvcConfigurer {
    /**
     * 枚举类的转换器工厂 addConverterFactory
     */
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverterFactory(new IntegerCodeToEnumConverterFactory());
        registry.addConverterFactory(new StringCodeToEnumConverterFactory());
    }
}

3.2 演示效果

使用0、1、man、woman都可以请求接口
在这里插入图片描述
接口返回值为0、1。还新增了字段sexText保存枚举的名称
在这里插入图片描述

4、项目代码地址

项目gitee链接: https://gitee.com/WillDistance/mybatis-plus-h2.git

<think>好的,用户想知道如何在Word中将英文小写字母转换为大写。首先,我需要回忆一下自己知道的Word功能。常用的方法可能有使用快捷键,或者通过菜单栏的字体设置来更改大小写。对了,我记得Shift+F3这个快捷键可以在不同的大小写格式之间切换,比如全大写、全小写或者首字母大写。这个应该适用于选中的文本。 另外,用户可能需要更详细的操作步骤。比如,在菜单栏中找到“开始”选项卡,然后点击“字体”组里的“更改大小写”按钮,选择“大写”选项。这种方法对于不熟悉快捷键的用户来说更直观。还有,如果用户需要批量处理多个段落或整个文档,可能需要使用查找和替换功能,或者编写宏来自动化操作。不过根据用户提供的引用,他们可能对VBA宏比较感兴趣,因为引用[3]提到了用VBA创建宏来处理金额转换。虽然问题不是关于数字而是英文大小写,但也许可以建议使用宏来处理更复杂的转换需求。 需要注意用户是否提到了具体的Word版本,但问题中没有说明,所以需要给通用方法,适用于大多数版本。同时,检查是否有其他方法,比如使用Word的公式功能或者插件,但常见的方法还是上述几种。还要确保步骤清晰,避免遗漏关键点,比如选中文本后再操作。另外,提醒用户注意全角半角的问题,但可能用户只是简单转换,不需要涉及这些细节。总结下来,回答应包括快捷键、菜单操作,以及可能的VBA方法,并引用提供的考资料中的相关部分,比如引用[3]的宏示例,虽然内容不同,但可以类比说明宏的可行性。</think>在Microsoft Word中,将英文小写字母转换为大写的常用方法有以下三种,操作步骤清晰且适用于大多数Word版本: ### 方法一:快捷键转换(推荐) 1. 选中需要转换的英文文本 2. 按下组合键$Shift+F3$ 3. 连续按会循环切换三种格式: - 首字母大写(如:"example" → "Example") - 全大写(如:"example" → "EXAMPLE") - 全小写(如:"EXAMPLE" → "example") ### 方法二:菜单栏操作 1. 选中目标文本 2. 点击「开始」选项卡 →「字体」组中的「更改大小写」按钮(Aa图标) 3. 在下拉菜单中选择「大写」 ### 方法三:VBA宏批量转换(适合批量处理) 1. 按$Alt+F11$打开VBA编辑器 2. 插新模块并粘贴以下代码: ```vba Sub ConvertToUpperCase() Selection.Range.Case = wdUpperCase End Sub ``` 3. 返回Word文档,选中文本后运行宏即可转换(可自定义快捷键绑定) 如果需要处理复杂格式或特殊需求,可以考类似数字转换中文大写的宏实现思路[^3],通过修改VBA代码实现更智能的转换功能。对于常规使用,前两种方法已足够高效,快捷键转换效率最佳,处理500字文档仅需3秒即可完成格式转换
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值