实战 Java 第11天：mybatis example通用查询商品类型列表

逃离我推掉我的手 2022-12-31 02:26 145阅读 0赞

### 实战 Java 第11天：mybatis example通用查询商品类型列表 ###

*   *   *  前言
         *  一、新建product\_type表
         *  二、新建ProductType实体类
         *  三、新建 ProductTypeMapper 接口
         *  四、新建ProductTypeMapper.xml文件
         *  五、新建 ProductTypeService 接口类
         *  六、新建 ProductTypeController 类并添加业务逻辑
         *  七、测试接口是否成功
         *  八、总结

### 前言 ###

商品类型查询也是比较常见的场景，今天不会使用之前查询商品列表时的原生sql写法，将使用mybatis通用example查询。

### 一、新建product\_type表 ###

1.  建表语句如下：

CREATE TABLE `product_type` (
      `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '自增主键',
      `name` varchar(100) DEFAULT NULL COMMENT '商品类别名称',
      `state` tinyint(2) DEFAULT '1' COMMENT '状态 1-有效 2-无效',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8 COMMENT='商品类别表';

### 二、新建ProductType实体类 ###

*  新建ProductType实体类

package com.dingding.entity;
    
    import javax.persistence.Table;
    
    /** * Created by xpwu on 2020/12/27. */
    @Table(name = "product_type")
    public class ProductType { 
    
        private Integer id;
        private String name;
        private Integer state;
    
        public Integer getId() { 
            return id;
        }
    
        public void setId(Integer id) { 
            this.id = id;
        }
    
        public String getName() { 
            return name;
        }
    
        public void setName(String name) { 
            this.name = name;
        }
    
        public Integer getState() { 
            return state;
        }
    
        public void setState(Integer state) { 
            this.state = state;
        }
    }

### 三、新建 ProductTypeMapper 接口 ###

新建ProductTypeMapper接口，并继承tk.mybatis.mapper.common.Mapper接口。

package com.dingding.mapper;
    
    import com.dingding.entity.ProductType;
    import tk.mybatis.mapper.common.Mapper;
    
    /** * Created by xpwu on 2020/12/27. */
    public interface ProductTypeMapper extends Mapper<ProductType> { 
    }

### 四、新建ProductTypeMapper.xml文件 ###

新建ProductTypeMapper.xml文件。

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="com.dingding.mapper.ProductTypeMapper">
        <resultMap id="BaseResultMap" type="com.dingding.entity.ProductType">
            <result column="id" jdbcType="INTEGER" property="id" />
            <result column="name" jdbcType="VARCHAR" property="name" />
            <result column="state" jdbcType="INTEGER" property="state" />
        </resultMap>
    </mapper>

### 五、新建 ProductTypeService 接口类 ###

*  新建 ProductTypeService 接口类，并添加接口selectValidList，实现商品类别查询。

package com.dingding.service;
    
    import com.dingding.entity.ProductType;
    
    import java.util.List;
    
    /** * Created by xpwu on 2020/12/27. */
    public interface ProductTypeService { 
    
        List<ProductType> selectValidList();
    }

*  新建 ProductTypeServiceImpl 类并添加实现。

package com.dingding.service.impl;
    
    import com.dingding.entity.ProductType;
    import com.dingding.mapper.ProductTypeMapper;
    import com.dingding.service.ProductTypeService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    import tk.mybatis.mapper.entity.Example;
    
    import java.util.List;
    
    /** * Created by xpwu on 2020/12/27. */
    @Service
    public class ProductTypeServiceImpl implements ProductTypeService { 
    
        @Autowired
        private ProductTypeMapper productTypeMapper;
    
        @Override
        public List<ProductType> selectValidList() { 
            // 查询有效数据
            int validState = 1;
            // 使用mybatis通用查询插件
            Example example = new Example(ProductType.class);
            Example.Criteria criteria = example.createCriteria();
            criteria.andEqualTo("state", validState);
            // productTypeMapper 继承通用tk.mybatis.mapper.common.Mapper类之后，可以调用其通用查询方法
            List<ProductType> productTypeList = productTypeMapper.selectByExample(example);
            return productTypeList;
        }
    }

### 六、新建 ProductTypeController 类并添加业务逻辑 ###

package com.dingding.controller;
    
    import com.dingding.entity.ProductType;
    import com.dingding.entity.Response;
    import com.dingding.service.ProductTypeService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.List;
    
    /** * Created by xpwu on 2020/12/27. */
    @RestController
    public class ProductTypeController { 
    
        @Autowired
        private ProductTypeService productTypeService;
    
        @RequestMapping(value = "/getProductTypeList",method = RequestMethod.GET)
        public Response getProductTypeList(){ 
            Response response = new Response();
            List<ProductType> list = productTypeService.selectValidList();
            response.setResponse(true,"查询成功",1, list);
            return response;
        }
    }

### 七、测试接口是否成功 ###

1.  使用 postman 验证接口。

*  验证商品类别查询接口  
    1）选择请求方式为 GET, 在地址栏中输入 http://localhost:8080/getProductTypeList，发送请求，正常返回列表数据。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDEzNTEyMQ_size_16_color_FFFFFF_t_70]

1.  对比数据库数据，结果为state=1的数据，验证OK。  
    ![在这里插入图片描述][20201227214226941.png]

### 八、总结 ###

mybatis通用查询的关键在于继承tk.mybatis.mapper.common.Mapper类之后，可以使用Mapper类中的各种查询方法，如selectByPrimaryKey、selectByExample等，无需手写sql，基础的CRUD sql，mybatis 会动态生成 sql 语句。同时，也可以使用Example通用查询条件类，不需要手写动态查询的相关sql语句。  
但是以上方法仅限于单表操作，如果有多表操作，还是需要按正常流程，手写sql及mapper接口。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDEzNTEyMQ_size_16_color_FFFFFF_t_70]: /images/20221120/ad5965b478be475e867ff77fec8958fe.png
[20201227214226941.png]: /images/20221120/dda80a23ccdc43d8a9a4e6484f42ce67.png