mybtais的好基友mybatisplus

小咪咪 2022-06-09 12:08 171阅读 0赞

mybatisplus 官方文档：[http://mp.baomidou.com/\#/][http_mp.baomidou.com]

阿mybatis-plus是mybatis的增强工具，在 Mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

一、mybatis-plus的代码生成器

引入mybatis-plus依赖：

<dependency>
    			<groupId>com.baomidou</groupId>
    			<artifactId>mybatisplus-spring-boot-starter</artifactId>
    			<version>1.0.1</version>
    		</dependency>
    		<dependency>
    			<groupId>com.baomidou</groupId>
    			<artifactId>mybatis-plus</artifactId>
    			<version>2.1-gamma</version>
    		</dependency>

第一个为mybatis-plus和spring-boot整合的依赖，第二个为mybatis-plus的核心依赖

生成代码工具类：

package cn.lsh;
    
    import com.baomidou.mybatisplus.generator.AutoGenerator;
    import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
    import com.baomidou.mybatisplus.generator.config.GlobalConfig;
    import com.baomidou.mybatisplus.generator.config.PackageConfig;
    import com.baomidou.mybatisplus.generator.config.StrategyConfig;
    import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
    import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
    import com.baomidou.mybatisplus.generator.config.rules.DbType;
    import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
    
    public class MpGenerator {
    
    	public static void main(String[] args) {
    		// TODO Auto-generated method stub
    		AutoGenerator mpg=new AutoGenerator();
    		
    		//全局配置
    		GlobalConfig gc=new GlobalConfig();
    		gc.setOutputDir("D:\\A161107004\\spring-boot-shiro-mp\\src\\main\\java");
    		gc.setFileOverride(true);//是否覆盖文件
    		gc.setActiveRecord(true);
    		gc.setEnableCache(false);
    		gc.setBaseResultMap(true);
    		gc.setBaseColumnList(false);
    		gc.setAuthor("lsh");
            //自定义文件命名，注意 %s 会自动填充表实体属性！,以下都是默认值，可以不设置
            gc.setMapperName("%sMapper");
            gc.setXmlName("%sMapper");
            gc.setServiceName("%sService");
            gc.setServiceImplName("%sServiceImpl");
            gc.setControllerName("%sController");
    		mpg.setGlobalConfig(gc);
    		
    		//数据源配置
    		DataSourceConfig dsc=new DataSourceConfig();
    		dsc.setDbType(DbType.MYSQL);
    		// 自定义数据库表字段类型转换【可选】
    		dsc.setTypeConvert(new MySqlTypeConvert(){
    			
    			@Override
    			public DbColumnType processTypeConvert(String fieldType) {
    				// TODO Auto-generated method stub
    				System.out.println("转换类型：" + fieldType);
    				return super.processTypeConvert(fieldType);
    			}
    		});
    		dsc.setDriverName("com.mysql.jdbc.Driver");
    		dsc.setUrl("jdbc:mysql://127.0.0.1:3306/shiro-mp?characterEncoding=utf8");
    		dsc.setUsername("root");
    		dsc.setPassword("123456");
    		mpg.setDataSource(dsc);
    		
    		//策略配置
    		StrategyConfig strategy=new StrategyConfig();
    		strategy.setTablePrefix(new String[]{"t_"});//配置表的前缀
    //		strategy.setExclude(new String[]{"t_user","t_role","t_permission"});//排除生成的表
    		//表名生成策略,采用驼峰式
    		strategy.setNaming(NamingStrategy.underline_to_camel);
    		// 字段名生成策略
    //       strategy.setFieldNming(NamingStrategy.underline_to_camel);
    //       自定义实体父类
    //       strategy.setSuperEntityClass("com.fcs.demo.TestEntity");
    //       自定义实体，公共字段
    //       strategy.setSuperEntityColumns(new String[] { "test_id", "age" });
    //       自定义 mapper 父类
    //       strategy.setSuperMapperClass("com.fcs.demo.TestMapper");
    //       自定义 service 父类
    //       strategy.setSuperServiceClass("com.fcs.demo.TestService");
    //       自定义 service 实现类父类
    //       strategy.setSuperServiceImplClass("com.fcs.demo.TestServiceImpl");
    //       自定义 controller 父类
    //       strategy.setSuperControllerClass("com.fcs.demo.TestController");
    //       【实体】是否生成字段常量（默认 false）
    //       public static final String ID = "test_id";
    //       strategy.setEntityColumnConstant(true);
    //       【实体】是否为构建者模型（默认 false）
    //       public User setName(String name) {this.name = name; return this;}
    //       strategy.setEntityBuliderModel(true);
    		mpg.setStrategy(strategy);
    		
    		//包配置
    		PackageConfig pc=new PackageConfig();
    		pc.setParent("cn.lsh");
    		pc.setModuleName("admin");
    		mpg.setPackageInfo(pc);
    		
    		mpg.execute();
    	}
    
    }

生成代码结构如下图所示：

![Center][]

PermissionMapper类：

package cn.lsh.admin.mapper;
    
    import java.util.List;
    
    import cn.lsh.admin.entity.Permission;
    
    import com.baomidou.mybatisplus.mapper.BaseMapper;
    import com.baomidou.mybatisplus.plugins.Page;
    
    /**
     * <p>
      *  Mapper 接口
     * </p>
     *
     * @author lsh
     * @since 2017-09-05
     */
    public interface PermissionMapper extends BaseMapper<Permission> {
        /*
         * 父类BaseMapper中定义了一系列crud操作，当然初次之外，也可以自己定义，如下，并在xml中配置sql语句
         */
    	
    	//可以自己定义查询方法
    	public List<Permission> selectPermList(Page<Permission> page);
    }

从这个类可以知道，mybatis-plus的所有mapper类都继承一个BaseMapper类，这个中定义了一系列的crud操作，我们可以直接拿来用，当然我们也可以在mepper类中实现自己的操作方法，但是必需在相应的xml文件中配置sql。

PermissionService：

package cn.lsh.admin.service.impl;
    
    import cn.lsh.admin.entity.Permission;
    import cn.lsh.admin.mapper.PermissionMapper;
    import cn.lsh.admin.service.PermissionService;
    
    import com.baomidou.mybatisplus.plugins.Page;
    import com.baomidou.mybatisplus.service.impl.ServiceImpl;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    /**
     * <p>
     *  服务实现类
     * </p>
     *
     * @author lsh
     * @since 2017-09-05
     */
    @Service
    public class PermissionServiceImpl extends ServiceImpl<PermissionMapper, Permission> implements PermissionService {
    
    	@Autowired
    	private PermissionMapper permissionMapper;
    	
    	@Override
    	public Page<Permission> selectPermPage(Page<Permission> page) {
    		// TODO Auto-generated method stub
    		page.setRecords(permissionMapper.selectPermList(page));
    		return page;
    	}
    	
    }

服务实现类不仅实现了服务接口，还继承了ServiceImpl这个父类，它提供了一些基本的crud操作，我们可以直接拿来用行了。

下面是一个测试类，测试分页查询

package cn.lsh.admin;
    
    import java.util.List;
    
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import com.baomidou.mybatisplus.mapper.EntityWrapper;
    import com.baomidou.mybatisplus.mapper.Wrapper;
    import com.baomidou.mybatisplus.plugins.Page;
    
    import cn.lsh.Application;
    import cn.lsh.admin.entity.Permission;
    import cn.lsh.admin.entity.User;
    import cn.lsh.admin.service.PermissionService;
    import cn.lsh.admin.service.UserService;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest(classes=Application.class)
    public class MybatisPlusTest {
    
    	@Autowired
    	private PermissionService permissionService;
    	@Autowired
    	private UserService userService;
    	
    	@Test
    	public void test(){
    		Permission permission=permissionService.selectById(1);
    		System.out.println(permission.getName());
    	}	
    	
    	@Test
    	public void testPage(){
    		Page<User> page=new Page<User>(0, 5);
    		Wrapper<User> wrapper=new EntityWrapper<User>();
    		wrapper.eq("sex", 1);
    		page=userService.selectPage(page, wrapper);
    		List<User> users=page.getRecords();
    		for(User user:users){
    			System.out.println(user.getId());
    		}
    	}
    }

[http_mp.baomidou.com]: http://mp.baomidou.com/#/
[Center]: /images/20220609/7cc18f9c0c6643e6b13d6a5ce88a1f64.png