springboot+mybatis+tkmybatis+postgresSQL实现主键返回，自定义handler处理数组和jsonb

最新推荐文章于 2024-03-24 15:03:05 发布
最新推荐文章于 2024-03-24 15:03:05 发布
阅读量1.8k 收藏 3
点赞数 2
分类专栏： spring boot myabtis postgresql 文章标签： mybatis spring boot postgresql
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/showchi/article/details/109852507
版权

文章目录

1、前言

公司的一个项目是用springdata jpa实现的，但是公司中没人对DDD有深入的了解，导致在开发过过程中大家都是面向数据库开发的，而通过jpa自动生成的表存才大量的外键（删除后也会自动添加上）， 导致大家在开发的过程中很是痛苦，所以就有了重构的项目，经过几天的时间还真让我自己给重构成功了，这里记录下在重构过程中遇到的问题，希望对大家有所帮助！

2、项目搭建

2.1 springboot搭建

springboot的搭建可以参考博主的另外一篇文章 idea创建Springboot 2.X项目

2.2 集成mybatis

  • 引入依赖坐标
<!-- mybatis -->
<dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <version>1.3.1</version>
</dependency>
  • 在application.yml或者application.propertiesz添加如下配置
#======================mybatis配置============================
mybatis:
  configuration:
    # 返回主键
    use-generated-keys: true
    # 开启驼峰功能
    map-underscore-to-camel-case: true
  type-aliases-package: com.chilx.entity
  # mapper的位置
  mapper-locations: classpath*:com/chilx/**/*.xml
  • 修改pom文件添加加载xml的配置（很多人忘记这一步）

我把mapper.xml放到了src/main/java包下所以要配置sources路径，否则回报xml找到不到的错误

<resources>
  <!-- 打包.xml文件 -->
  <resource>
    <directory>src/main/java</directory>
    <includes>
      <include>**/*.xml</include>
    </includes>
  </resource>
  <resource>
    <directory>src/main/resources</directory>
    <includes>
      <include>**/*.*</include>
    </includes>
  </resource>
</resources>

2.3 集成tk.mapper

  • 引入坐标依赖
<!-- mapper springboot专用的stater -->
<dependency>
  <groupId>tk.mybatis</groupId>
  <artifactId>mapper-spring-boot-starter</artifactId>
  <version>1.2.3</version>
</dependency>
  • 在application.yml或者application.propertiesz添加如下配置
#======================mapper配置============================
mapper:
  mappers:
    - com.chilx.common.BaseInfoMapper
  # 对于一般的getAllIfColumnNode，是否判断!=''，默认不判断
  not-empty: false
  # 获取主键自增回写SQL
  IDENTITY: SELECT nextval({0})
  # 指定序列格式化方式 nextval({0}) 获取下一个id
  # 当实体类指定序列是必须开启此配置
  seq-format: nextval({0})
  # 写入之前
  before: true
  # 是否只处理基本类型: 当为true时才会处理arry和jsonb处理复杂类型
  use-simple-type: false

  • 最后在启动类上扫描mapper

    注意： 引用的是tk.mybatis.spring.annotation.MapperScan而不是org.mybatis.spring.annotation.MapperScan

@SpringBootApplication
// 此处配置*mapper.java所在的包路径
@MapperScan(basePackages = "com.chilx.dao")
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

2.4 集成postgreSQL

  • 引入坐标依赖
<dependency>
  <groupId>org.postgresql</groupId>
  <artifactId>postgresql</artifactId>
  <version>42.1.4</version>
</dependency>
  • 在application.yml或者application.propertiesz添加如下配置
spring:
  #======================数据库配置============================
  datasource:
    url: jdbc:postgresql://localhost:5432/postgres?useSSL=false&stringtype=unspecified
    username: postgres
    password: 123456
    driver-class-name: org.postgresql.Driver

2.5 集成pagehelper

  • 引入坐标依赖
<!-- 分页插件 -->
<dependency>
  <groupId>com.github.pagehelper</groupId>
  <artifactId>pagehelper-spring-boot-starter</artifactId>
  <version>1.2.3</version>
</dependency>
  • 在application.yml或者application.propertiesz添加如下配置

具体参数配置

#======================分页配置============================
pagehelper:
  helperDialect: postgresql
  # 分页合理化参数，默认值为false。
  # 当该参数设置为 true 时，pageNum<=0 时会查询第一页， pageNum>pages（超过总数时），会查询最后一页。
  # 默认false 时，直接根据参数进行查询
  reasonable: true
  supportMethodsArguments: true
  params: count=countSql

2.6 添加库表

添加用户信息表

-- 用户信息表
CREATE TABLE "public"."user_info" (
  "id" serial4 NOT NULL,
  "user_name" varchar(255) COLLATE "pg_catalog"."default",
  "hobbies" varchar[] COLLATE "pg_catalog"."default",
  "hobbies_detail" jsonb,
  "lover" jsonb,
  CONSTRAINT "user_info_pkey" PRIMARY KEY ("id")
)
;

ALTER TABLE "public"."user_info" 
  OWNER TO "postgres";

COMMENT ON COLUMN "public"."user_info"."id" IS '主键';

COMMENT ON COLUMN "public"."user_info"."user_name" IS '姓名';

COMMENT ON COLUMN "public"."user_info"."hobbies" IS '爱好';

COMMENT ON COLUMN "public"."user_info"."hobbies_detail" IS '爱好详情';

COMMENT ON COLUMN "public"."user_info"."lover" IS '喜欢的人';

项目的基本架构到这里算是搭建完成，下面让我们生成对应的实体和mapper文件并进行相应的配置

3、项目配置

3.1 生成实体文件

利用mybatis-generator生成对应的实体和mapper文件并进行修改， 生成过程这里不在赘述网上多的是！

  • 修改生成的实体UserInfo
import com.chilx.handler.ArrayTypeHandler;
import com.chilx.handler.HobbyArrayHandler;
import com.chilx.handler.UserInfoHandler;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import tk.mybatis.mapper.annotation.ColumnType;

import javax.persistence.*;

@Table(name = "public.user_info")
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UserInfo {
    /**
     * 主键
     * GeneratedValue
     *      strategy: 主键生成策略 这里使用序列;
     *      generator: 对应SequenceGenerator中的name属性,可自定义两者一直即可;
     * SequenceGenerator
     *      name: 对应GeneratedValue中的generator的属性,可自定义两者一直即可;
     *      sequenceName: 生成id的序列, 注意这里需要用单引号引着;
     *      allocationSize: 步增大小
     */
    @Id
    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator="seq")
    @SequenceGenerator(name = "seq", sequenceName = "'user_info_id_seq'", allocationSize = 1)
    private Integer id;

    /**
     * 姓名
     */
    @Column(name = "user_name")
    private String userName;

    /**
     * 爱好
     */
    @Column(name = "hobbies")
    // 配置数组类型转化器
    @ColumnType(column = "hobbies", typeHandler = ArrayTypeHandler.class)
    private String[] hobbies;

    /**
     * 爱好详情
     */
    @Column(name = "hobbies_detail")
    // 配置实体数组类型转化器
    @ColumnType(column = "hobbies_detail", typeHandler = HobbyArrayHandler.class)
    private Hobby[] hobbiesDetail;

    /**
     * 喜欢的人
     */
    @Column(name = "lover")
    // 配置实体类型转化器
    @ColumnType(column = "lover", typeHandler = UserInfoHandler.class)
    private UserInfo lover;
}
  • 修改UserInfo.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.chilx.dao.UserInfoMapper">
    <resultMap id="BaseResultMap" type="com.chilx.entity.UserInfo">
        <id column="id" property="id" jdbcType="INTEGER"/>
        <result column="user_name" property="userName" jdbcType="VARCHAR"/>
        <result column="hobbies" property="hobbies" typeHandler="com.chilx.handler.ArrayTypeHandler"/>
        <result column="hobbies_detail" property="hobbiesDetail" typeHandler="com.chilx.handler.HobbyArrayHandler"/>
        <result column="lover" property="lover" typeHandler="com.chilx.handler.UserInfoHandler"/>
    </resultMap>
</mapper>

3.2 类型转换器

3.2.1 数组类型转换器

import java.sql.*;


/**
 * mybatis 数组类型处理器
 *
 * @author chilx
 * @date 2020/11/20
 **/
@MappedJdbcTypes(JdbcType.ARRAY)
@MappedTypes(String[].class)
public class ArrayTypeHandler extends BaseTypeHandler<Object[]> {

    private static final String TYPE_NAME_VARCHAR = "varchar";
    private static final String TYPE_NAME_INTEGER = "integer";
    private static final String TYPE_NAME_BOOLEAN = "boolean";
    private static final String TYPE_NAME_NUMERIC = "numeric";

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, Object[] parameter, JdbcType jdbcType) throws SQLException {
        String typeName = null;
        if (parameter instanceof Integer[]) {
            typeName = TYPE_NAME_INTEGER;
        } else if (parameter instanceof String[]) {
            typeName = TYPE_NAME_VARCHAR;
        } else if (parameter instanceof Boolean[]) {
            typeName = TYPE_NAME_BOOLEAN;
        } else if (parameter instanceof Double[]) {
            typeName = TYPE_NAME_NUMERIC;
        }

        if (typeName == null) {
            throw new TypeException("ArrayTypeHandler parameter typeName error, your type is " + parameter.getClass().getName());
        }

        // 这3行是关键的代码，创建Array，然后ps.setArray(i, array)就可以了
        Connection conn = ps.getConnection();
        Array array = conn.createArrayOf(typeName, parameter);
        ps.setArray(i, array);
    }

    @Override
    public Object[] getNullableResult(ResultSet resultSet, String s) throws SQLException {
        return getArray(resultSet.getArray(s));
    }

    @Override
    public Object[] getNullableResult(ResultSet resultSet, int i) throws SQLException {
        return getArray(resultSet.getArray(i));
    }

    @Override
    public Object[] getNullableResult(CallableStatement callableStatement, int i) throws SQLException {
        return getArray(callableStatement.getArray(i));
    }

    private Object[] getArray(Array array) {
        if (array == null) {
            return null;
        }
        try {
            return (Object[]) array.getArray();
        } catch (Exception e) {
        }
        return null;
    }

3.2.2 实体类型转换器

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.chilx.entity.UserInfo;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.MappedJdbcTypes;
import org.apache.ibatis.type.MappedTypes;
import org.postgresql.util.PGobject;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * mybatis JSON类型处理器
 *
 * @author chilx
 * @date 2020/11/20
 **/
@MappedJdbcTypes(JdbcType.OTHER)
@MappedTypes(UserInfo.class)
public class UserInfoHandler extends BaseTypeHandler<UserInfo> {
    private static final PGobject PG_OBJECT = new PGobject();

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, UserInfo parameter, JdbcType jdbcType)
            throws SQLException {
        if (ps != null) {
            PG_OBJECT.setType("jsonb");
            PG_OBJECT.setValue(JSON.toJSONString(parameter));
            ps.setObject(i, PG_OBJECT);
        }
    }

    @Override
    public UserInfo getNullableResult(ResultSet rs, String columnName) throws SQLException {
        return getArray(rs.getObject(columnName));
    }

    @Override
    public UserInfo getNullableResult(ResultSet rs, int columnIndex) throws SQLException {

        return getArray(rs.getObject(columnIndex));
    }

    @Override
    public UserInfo getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {

        return getArray(cs.getObject(columnIndex));
    }


    private UserInfo getArray(Object obj) {
        if (obj == null) {
            return null;
        }
        try {
            Object value = JSONObject.parseObject(JSON.toJSONString(obj)).get("value");
            return JSON.parseObject(value.toString(), UserInfo.class);
        } catch (Exception ignored) {
        }
        return null;
    }
}

3.2.3 实体数组类型转换器

和实体类型转换是一样的， 只是一个是单个实体一个是数组

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.chilx.entity.Hobby;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.MappedJdbcTypes;
import org.apache.ibatis.type.MappedTypes;
import org.postgresql.util.PGobject;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * mybatis 数组类型处理器
 *
 * @author chilx
 * @date 2020/11/20
 **/
@MappedJdbcTypes(JdbcType.OTHER)
@MappedTypes(Hobby[].class)
public class HobbyArrayHandler extends BaseTypeHandler<Hobby[]> {
    private static final PGobject PG_OBJECT = new PGobject();

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, Hobby[] parameter, JdbcType jdbcType)
            throws SQLException {
        if (ps != null) {
            PG_OBJECT.setType("jsonb");
            PG_OBJECT.setValue(JSON.toJSONString(parameter));
            ps.setObject(i, PG_OBJECT);
        }
    }

    @Override
    public Hobby[] getNullableResult(ResultSet rs, String columnName) throws SQLException {
        return getArray(rs.getObject(columnName));
    }

    @Override
    public Hobby[] getNullableResult(ResultSet rs, int columnIndex) throws SQLException {

        return getArray(rs.getObject(columnIndex));
    }

    @Override
    public Hobby[] getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {

        return getArray(cs.getObject(columnIndex));
    }


    private Hobby[] getArray(Object obj) {
        if (obj == null) {
            return null;
        }
        try {
            Object value = JSONObject.parseObject(JSON.toJSONString(obj)).get("value");
            return JSON.parseObject(value.toString(), Hobby[].class);
        } catch (Exception ignored) {
        }
        return null;
    }
}

3.3 返回主键配置

  • 配置文件
# mybatis增加以下配置（2.2已配置）
mybatis:
  configuration:
    # 返回主键
    use-generated-keys: true

# mapper增加以下配置（2.3已配置）
mapper:
  # 获取主键自增回写SQL
  IDENTITY: SELECT nextval({0})
  # 指定序列格式化方式 nextval({0}) 获取下一个id
  # 当实体类指定序列是必须开启此配置
  seq-format: nextval({0})
  # 写入之前
  before: true
  # 是否只处理简单类型,
  #  true: 只处理基本数据类型
  #  false: 处理复杂类型,包含自定义handler
  use-simple-type: false
  • 实体类主键添加注解
    /**
     * 主键
     * GeneratedValue
     *      strategy: 主键生成策略 这里使用序列;
     *      generator: 对应SequenceGenerator中的name属性,可自定义两者一直即可;
     * SequenceGenerator
     *      name: 对应GeneratedValue中的generator的属性,可自定义两者一直即可;
     *      sequenceName: 生成id的序列, 注意这里需要用单引号引着;
     *      allocationSize: 步增大小
     */
    @Id
    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator="seq")
    @SequenceGenerator(name = "seq", sequenceName = "'user_info_id_seq'", allocationSize = 1)
    private Integer id;

3.2 复杂类型返回

  • 配置文件
mapper:
  # 是否只处理简单类型,
  #  true: 只处理基本数据类型
  #  false: 处理复杂类型,包含自定义handler
  use-simple-type: false

  • 自定义handler

    详情自定分 — > 3.2 类型转换器

4、测试

4.1 增加

在这里插入图片描述

4.2 修改

在这里插入图片描述

4.3 查询

在这里插入图片描述

4.4 删除

在这里插入图片描述

5、大功告成！！！

附上项目地址:
码云

github

chilx
关注
  • 2
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
mybitas-generator
07-25
mybitas 无IDE关联版本的自动生成代码工具包和方法
springboot+mybatis+sqlserver
04-12
这是个人搭建的基础开发框架，比较简单，可以自由拓展。里面还包含了部分钉钉api,有问题请留言指教小弟
SpringBoot3集成PostgreSQL
【积累】，是一个长期持续的过程。
03-24 1577
PostgreSQL是一个功能强大的开源数据库系统，具有可靠性、稳定性、数据一致性等特点，且可以运行在所有主流操作系统上，包括Linux、Unix、Windows等。
tk-mybatis连接pgsql插入数据主键id自增报错
lazylly的博客
12-21 4052
tk-mybatis连接pgsql插入数据主键id自增报错
mybatis+postgresql返回递增主键的正确姿势及勘误
一名普通码农的菜地
05-25 5817
前言某日需要更换成为postgresql，于是，mybatis返回递增主键便是一个问题。网上做法 <selectKey keyProperty="id" resultType="java.lang.Long" order="BEFORE"> SELECT nextval('serial_project_id') </selectKey> ` ``
springboot整合MyBatis-Plus和postgresql
lll7777773的博客
07-10 3674
navicat 连接postgresql 注：navicat老版本可能报错。1.在springboot中引入我们需要的依赖以及相应版本。用代码生成器生成代码后，即可进行增删改查（略）安装好postgresql 略。更改配置信息（注释中有）
PostgreSql&Mysql使用TkMybatis的insert或者insertSelective返回主键
Zhangmaoyang的博客
05-24 2331
MySQL: 在实体类主键字段上使用: @Id @GeneratedValue(strategy = GenerationType.IDENTITY,generator = "JDBC") PostgreSQL: 在实体类主键字段上使用: @Id @KeySql(useGeneratedKeys = true) @Column(name = "id",insertable = false) 稍微有点区别,记录一下,另外 PostgreSQL使用Myb...
tk-mybatis + PostgreSQL返回主键自增
shangcunshanfu的博客
12-07 1362
tk-mybatis框架对PostgreSQL好像并不怎么友好，没有直接给出返回自增主键的功能，不过我们可以自己稍做努力加以实现。 在tk-mybatis的tk.mybatis.mapper.common.base.insert.InsertSelectiveMapper接口中提供了通用的insert操作，该接口并没有提供返回自增主键的功能，如下： /** * 通用Mapper接口,插入 * * @param <T> 不能为空 * @author liuzh */ @Regist
Mysql迁移Kingbase，使用tk.mybatis进行保存数据时遇到的id插入问题
GuaGea的博客
06-20 320
在Mysql迁移Kingbase时，再插入数据的时候遇到了一些关于id方面的问题，进行解决。
postgresql之mybatis.generator的使用
meetzss的博客
04-06 491
【代码】postgresql之mybatis.generator的使用。
【SpringBoot】Mybatis执行insert/update后如何获得主键id
03-08 3620
比如我使用INSERT一次插入了 4 条数据，它们的 id 分别是 1,2,3,4，那么最后返回的ID还是 1 这个值。System.out.println("主键："+masterSQL.getId());框架的insert语句默认是不返回记录的主键值，而是返回插入的记录条数的，但是如果业务层需要得到插入数据的主键时候，可以通过配置的方式来实现获取插入数据的ID功能。1、这两种方式都仅支持主键自增类型的数据库 MySQL 和 SqlServer,Oracle不支持，并且设置的ID是自增类型的才行；
基于SpringBoot + MyBatis + Layui的后台权限管理系统.zip
07-08
基于SpringBoot + MyBatis + Layui的后台权限管理系统。代码简洁易懂、界面美观大方，内部封装了权限管理系统常用的全部功能，可直接作为快速开发JavaWeb项目的脚手架使用。 基于SpringBoot + MyBatis + Layui的...
springboot+mybatis+sqlserver 仓库管理系统
05-27
基于springboot开发的简单且实用的仓库系统，拥有复制，导出，打印等多功能。新增几乎都是自动带出，并且还有列点击排序，列随意拖动等实用功能。
基于springboot+mybatis微信小程序+源代码+文档说明
11-28
- ## 项目备注 1、该资源内项目代码都经过...3、如果基础还行，也可在此代码基础上进行修改，以实现其他功能，也可用于毕设、课设、作业等。 下载后请首先打开README.md文件（如有），仅供学习参考, 切勿用于商业用途。
基于SpringBoot+MyBatis前后端开发的博客网站项目源码.zip
01-06
1、基于SpringBoot+MyBatis前后端开发的博客网站项目源码.zip 2、该资源包括项目的全部源码，下载可以直接使用！ 3、本项目适合作为计算机、数学、电子信息等专业的课程设计、期末大作业和毕设项目，作为参考资料...
MyBatis魔法堂：Insert操作详解（返回主键、批量插入）
weixin_33910759的博客
11-06 5826
一、前言　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　      数据库操作怎能少了INSERT操作呢？下面记录MyBatis关于INSERT操作的笔记，以便日后查阅。   二、 insert元素 属性详解　　　　　　　　　　　　　　　　　　　　　　　　　　　　   其属性如下：    parameterType ，入参的全限定类名或类型别名    keyColumn...
【Mybatis】Mybatis-Generator-Postgresql-返回主键
HuHui_的博客
12-21 1406
文章目录系列前言装备Core-Codesqlmybatis-implementplugin-code使用方法generatorConfig.xmlpom.xmlGithub作者 系列 【Mybatis】Mybatis-Generator-Postgresql返回主键插件 【Mybatis】Mybatis-Generator-Oracle返回主键插件 【Mybatis】Mybatis-Genera...
mybatis+postgresql+insert返回主键,action，service侧
jueshengtianya的专栏
11-28 2783
mybatis+postgresql+insert返回主键,action，service侧 在网上找了很久主要的内容如下： SELECT currval(‘tb_dynavisit_info_id_seq’) INSERT INTO tb_dynavisit_info( id, vehicle_code ) VALUES( nextVal(‘tb_dynavisit_
MyBatis+PostgreSQL处理pg中json及_varchar字段类型数据（插入及查询）
qq_42513284的博客
05-25 4590
MyBatis+PostgreSQL postgrel中存在json和数组类型的字段，而mybatis原生并不支持这种类型（即jdbcType不存在JSON或者数组类型），如果想要将json或者数组格式的数据插入到pg数据库，那么mybatis提供了BaseTypeHandler已供开发者自己扩展，开发者需要根据自己的业务实现（implements）或者继承（extends）BaseTypeHandler。 下面将展示把List<String> 和 JSONObject类型（java）的数据
springboot+mybatis实现分区表
最新发布
05-07
在SpringBoot和MyBatis中实现分区表可以通过使用MyBatis-Plus插件实现。MyBatis-Plus是MyBatis的增强工具，在MyBatis的基础上提供了更多的功能和便捷的操作方式，包括分区表的实现。 下面是一个简单的示例，演示...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值