SpringMVC对枚举类型输入输出及Mybatis对枚举类型的存储查询

古城微笑少年丶 2022-04-18 03:38 242阅读 0赞

### 文章目录 ###

*   *  摘要
     *  准备环境
     *  Spring MVC接收枚举类型
     *  Spring MVC输出枚举类型
     *  MyBatis存储查询枚举类型
     *  测试

## 摘要 ##

本文使用SpringBoot.2.0.1.RELEASE进行快速搭建项目，数据库采用内存数据H2，使用性别枚举作为例子讲解SpringMVC及Mybatis枚举类型处理。

## 准备环境 ##

**maven依赖**

加入如下依赖后，SpringBoot自动配置H2数据库作为数据源，Mybatis作为ORM框架，同时使用lombok简化代码。

<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.mybatis.spring.boot</groupId>
    			<artifactId>mybatis-spring-boot-starter</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>com.h2database</groupId>
    			<artifactId>h2</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>com.alibaba</groupId>
    			<artifactId>fastjson</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.projectlombok</groupId>
    			<artifactId>lombok</artifactId>
    		</dependency>

**建表语句**

在resources目录下新建schema.sql，该版本SpringBoot启动会默认执行里面的SQL语句。加入H2数据库依赖后，SpringBoot默认以H2作为数据源。

CREATE TABLE user (
      id INT NOT NULL AUTO_INCREMENT COMMENT 'id',
      name VARCHAR (16) COMMENT '姓名',
      sex INT COMMENT '性别',
      PRIMARY KEY (id)
    );

**Java类**

性别枚举类和用户类

@AllArgsConstructor
    public enum SexEnum { 
        MALE(1, "男"),
        FEMALE(2, "女");
    
        @Getter
        private Integer code;
        @Getter
        private String desc;
    
        private static final Map<Integer, SexEnum> MAPPINGS = new HashMap<>(8);
    
        static { 
            for (SexEnum sexEnum : values()) { 
                MAPPINGS.put(sexEnum.code, sexEnum);
            }
        }
    
        public static SexEnum resolve(Object code) { 
            return (code != null ? MAPPINGS.get(code) : null);
        }
    }
    @Data
    public class User { 
        private Integer id;
        private String name;
        private SexEnum sex;
    }

## Spring MVC接收枚举类型 ##

若希望实现输入参数1或2，接收到SexEnum类型的男和女  
1 创建自定义转换器并实现Converter接口  
2 把转换器加入SpringMVC配置

/** * SpringMVC的配置类 */
    @Configuration
    public class WebConfig implements WebMvcConfigurer { 
    
    	/** * SpringMVC接收的参数都是Stirng类型，因此转换器应该是String->Enum，而不是int->Enum */
        class StringToSexEnumConverter implements Converter<String, SexEnum> { 
    
            @Override
            public SexEnum convert(String source) { 
                if (source == null) { 
                    return null;
                }
                try { 
                    Integer code = Integer.parseInt(source);
                    return SexEnum.resolve(code);
                } catch (NumberFormatException e) { 
                    throw e;
                }
            }
        }
    
    	/** * 将自定义转换器注册到配置中 */
        @Override
        public void addFormatters(FormatterRegistry registry) { 
            registry.addConverter(new StringToSexEnumConverter());
        }
    }

## Spring MVC输出枚举类型 ##

SpringMVC默认以Jackson作为序列化工具，因此通过Jackson的@JsonSerialize就可以控制枚举类型输出。  
1 创建自定义序列化类并继承JsonSerializer实现类  
2 配置序列化类到SexEnum上

/** * 自定义序列化规则。此处希望Web接口返回男或女 */
    public class SexEnumSerializer extends JsonSerializer<SexEnum> { 
        @Override
        public void serialize(SexEnum value, JsonGenerator gen, SerializerProvider serializers) throws IOException { 
            if (value == null) { 
                gen.writeNull();
            } else { 
                gen.writeObject(value.getDesc());
            }
        }
    }
    @AllArgsConstructor
    // 通过该注解执行序列化规则
    @JsonSerialize(using = SexEnumSerializer.class)
    public enum SexEnum { 
    	// 略
    }

## MyBatis存储查询枚举类型 ##

MyBatis提供了TypeHandler接口，作为自定义类型的处理类，此处只是以枚举为例。  
1 创建自定义类型处理器并实现TypeHandler接口  
2 配置自定义类型处理器

// 配置类型处理器处理的Java类型
    @MappedTypes(SexEnum.class)
    // 配置类型处理器处理的JDBC类型
    @MappedJdbcTypes(JdbcType.INTEGER)
    public class SexEnumTypeHandler implements TypeHandler<SexEnum> { 
    	// 该方法用于当枚举作为参数的处理。
        @Override
        public void setParameter(PreparedStatement ps, int i, SexEnum parameter, JdbcType jdbcType) throws SQLException { 
            if (parameter == null) { 
                ps.setObject(i, null);
            } else { 
                ps.setInt(i, parameter.getCode());
            }
        }
        // 下面三个方法用于得到查询结果后，处理枚举类型的策略
        @Override
        public SexEnum getResult(ResultSet rs, String columnName) throws SQLException { 
            Object code = rs.getObject(columnName);
            return code == null ? null : SexEnum.resolve(code);
        }
        @Override
        public SexEnum getResult(ResultSet rs, int columnIndex) throws SQLException { 
            Object code = rs.getObject(columnIndex);
            return code == null ? null : SexEnum.resolve(code);
        }
        @Override
        public SexEnum getResult(CallableStatement cs, int columnIndex) throws SQLException { 
            Object code = cs.getObject(columnIndex);
            return code == null ? null : SexEnum.resolve(code);
        }
    }

application.yml加入如下配置，扫描上面的自定义类型处理器

mybatis:
      type-handlers-package: com.example.mybatis.handler

## 测试 ##

**准备工作**  
创建Mapper、Controller、启动类

@Mapper
    public interface UserMapper { 
        @Options(useGeneratedKeys = true)
        @Insert("INSERT INTO user (name,sex) VALUES (#{name},#{sex})")
        void insert(User user);
        
        @Select("SELECT * FROM user")
        List<User> findAll();
    }
    
    @RestController
    public class TypeHandlerController { 
    	// 方便起见。此处直接使用Mapper
        @Autowired
        private UserMapper userMapper;
    
        @RequestMapping("/addUser")
        public User addUser(User user) { 
            userMapper.insert(user);
            return user;
        }
        @RequestMapping("/findAll")
        public List<User> findAll() { 
            return userMapper.findAll();
        }
    }
    @SpringBootApplication
    public class MybatisApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(MybatisApplication.class, args);
        }
    }

**测试代码**

启动项目，测试接口。实现了枚举类型的输入输出及数据库的存储查询。

输入 ：http://localhost:8080/addUser?name=ly&sex=1
    输出 ：{"id":1,"name":"ly","sex":"男"}
    输入 ：http://localhost:8080/addUser?name=swj&sex=2
    输出 ：{"id":2,"name":"swj","sex":"女"}
    输入 ：http://localhost:8080/findAll
    输出 ：[{"id":1,"name":"ly","sex":"男"},{"id":2,"name":"swj","sex":"女"}]