jOOQ入门

2021-06-28 Java jOOQ 0 评论字数统计: 3.3k(字) 阅读时长: 16(分)

jOOQ入门

公司的 ORM 框架用的是 jOOQ

之前为了学 spring 全家桶学习的 mybatis 和 mybatis plus 都白学了

好吧我又继续学习了

概述

官网对于为什么使用 jOOQ 的描述如下

So why not just use SQL?

SQL can be written as plain text and passed through the JDBC API. Over the years, people have become wary of this approach for many reasons:

- No typesafety 无类型安全

- No syntax safety 无语法安全

- No bind value index safety 无绑定值索引安全性

- Verbose SQL String concatenation 冗长的SQL字符串拼接

- Boring bind value indexing techniques 乏味的绑定值索引技术

- Verbose resource and exception handling in JDBC JDBC中的详细资源和异常处理

- A very “stateful”, not very object-oriented JDBC API, which is hard to use 一个非常“有状态”的、不是非常面向对象的JDBC API，很难使用

因为以上这些原因,在过去,很多框架尝试以各种方式去抽象 JDBC. 但是不幸的是,很多框架把 SQL 也抽象掉了. jOOQ 可以将这一空白填充.

这样看起来,感觉口气很狂的样子,然后继续看一下官网的介绍

jOOQ is different

SQL was never meant to be abstracted. To be confined in the narrow boundaries of heavy mappers, hiding the beauty and simplicity of relational data. SQL was never meant to be object-oriented. SQL was never meant to be anything other than… SQL!

翻译过来就是说:

SQL 从来就不是抽象的.被限制在mappers 的狭窄的区域中,被隐藏了数据关联的美丽和简单

SQL 从来就不是面向对象的.

SQL 从来就不是任何东西, 除了 SQL!

好吧这么一看,喷了很多框架啊,哈哈哈开发者个性我喜欢

jOOQ 的不同

jOOQ has originally been created as a library for complete abstraction of JDBC and all database interaction. Various best practices that are frequently encountered in pre-existing software products are applied to this library. This includes:

- Typesafe database object referencing through generated schema, table, column, record, procedure, type, dao, pojo artefacts (see the chapter about code generation) 通过生成的模式、表、列、记录、过程、类型、dao和pojo构件引用类型安全数据库对象

- Typesafe SQL construction / SQL building through a complete querying DSL API modelling SQL as a domain specific language in Java (see the chapter about the query DSL API) 类型安全SQL构建/ SQL构建通过一个完整的查询DSL API建模的SQL

- Convenient query execution through an improved API for result fetching (see the chapters about the various types of data fetching) 通过改进的用于结果获取的API方便地执行查询

- SQL dialect abstraction and SQL clause emulation to improve cross-database compatibility and to enable missing features in simpler databases (see the chapter about SQL dialects) SQL方言抽象和SQL子句模拟，以提高跨数据库兼容性，并在更简单的数据库中启用缺少的特性

- SQL logging and debugging using jOOQ as an integral part of your development process (see the chapters about logging) SQL日志记录和调试

Effectively, jOOQ was originally designed to replace any other database abstraction framework short of the ones handling connection pooling (and more sophisticated transaction management) 实际上，jOOQ最初的设计是为了取代除处理连接池之外的任何其他数据库抽象框架

好,很棒

使用 jOOQ 的几种方式

- Using Hibernate for 70% of the queries (i.e. CRUD) and jOOQ for the remaining 30% where SQL is really needed

- Using jOOQ for SQL building and JDBC for SQL execution

- Using jOOQ for SQL building and Spring Data for SQL execution

- Using jOOQ without the source code generator to build the basis of a framework for dynamic

SQL execution.

教程

好记性不如烂笔头,跟着官网的 7 步成 jOOQ 教程走一波

准备

下载jOOQ 或者通过 maven 引入

官网的话https://www.jooq.org/download/

我使用的是 maven 方式

首先建了一个空白的 maven 项目,在 pom 中引入:

<dependency>
  <groupId>org.jooq</groupId>
  <artifactId>jooq</artifactId>
</dependency>
<dependency>
  <groupId>org.jooq</groupId>
  <artifactId>jooq-meta</artifactId>
</dependency>
<dependency>
  <groupId>org.jooq</groupId>
  <artifactId>jooq-codegen</artifactId>
</dependency>

数据库数据准备

CREATE DATABASE `library`;
USE `library`;
CREATE TABLE `author` (
`id` int NOT NULL,
`first_name` varchar(255) DEFAULT NULL, `last_name` varchar(255) DEFAULT NULL, PRIMARY KEY (`id`)
);

代码生成

在 resources 中创建一个 xml 文件, 使用官网给出的模板

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configuration xmlns="http://www.jooq.org/xsd/jooq-codegen-3.9.2.xsd">
  <!-- Configure the database connection here -->
  <jdbc>
    <driver>com.mysql.jdbc.Driver</driver>
    <!-- 数据库url -->
    <url>jdbc:mysql://localhost:3306/library?useUnicode=true&amp;characterEncoding=UTF-8</url>
    <!-- 数据库账号 -->
    <user>root</user>
    <!-- 数据库账号密码 -->
    <password>123456</password>
  </jdbc>

  <generator>
    <!-- The default code generator. You can override this one, to generate your own code style.
         Supported generators:
         - org.jooq.util.JavaGenerator
         - org.jooq.util.ScalaGenerator
         Defaults to org.jooq.util.JavaGenerator -->
    <name>org.jooq.util.JavaGenerator</name>

    <database>
      <!-- The database type. The format here is:
           org.util.[database].[database]Database -->
      <name>org.jooq.util.mysql.MySQLDatabase</name>

      <!-- The database schema (or in the absence of schema support, in your RDBMS this
           can be the owner, user, database name) to be generated -->
      <inputSchema>library</inputSchema>

      <!-- All elements that are generated from your schema
           (A Java regular expression. Use the pipe to separate several expressions)
           Watch out for case-sensitivity. Depending on your database, this might be important! -->
      <includes>.*</includes>

      <!-- All elements that are excluded from your schema
           (A Java regular expression. Use the pipe to separate several expressions).
           Excludes match before includes, i.e. excludes have a higher priority -->
      <excludes></excludes>
    </database>

    <target>
      <!-- The destination package of your generated classes (within the destination directory) -->
      <!-- 生成的包名，生成的类在此包下 -->
      <packageName>zone.yiqing.learnjooq.generated</packageName>

      <!-- The destination directory of your generated classes. Using Maven directory layout here -->
      <!-- 输出的目录 -->
      <directory>/Users/yiqing/Documents/programming/projects/learn-jooq/src/main/java</directory>
    </target>
  </generator>
</configuration>

其中:

替换 sql 连接的账号密码
packageName: 设置为用于生成代码的 classes 的 parent package
directory: 输出生成 classes 的目录

生成代码

使用 maven 插件

https://www.jooq.org/doc/3.0/manual/code-generation/codegen-configuration/

这个方法应该是最简单的方法

但是我在这个方法一直报错,最终尝试了其他方法

之后又尝试了此方法,发现和注 1 是一样的原因导致的报错,所以,切记版本选择!!!

maven 插件:

<build>
    <plugins>
      <plugin>
        <groupId>org.jooq</groupId>
        <artifactId>jooq-codegen-maven</artifactId>
        <version>${jooq.version}</version>
        <executions>
          <execution>
            <goals>
              <goal>generate</goal>
            </goals>
          </execution>
        </executions>
        <dependencies>
          <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql.connector.version}</version>
          </dependency>
        </dependencies>
        <configuration>
          <configurationFile>src/main/resources/library.xml</configurationFile>
        </configuration>
      </plugin>
    </plugins>
  </build>

然后直接使用 maven 的 compile 即可产生代码,非常方便

使用生成器生成

将 jOOQ 的三个文件和 mysql connector的 jar 包复制到一个目录,在本例中是 generated.将之前创建的 library.xml 也复制进来

cd 到这个目录

执行:

1	java -classpath jooq-3.9.5.jar:jooq-meta-3.9.5.jar:jooq-codegen-3.9.5.jar:mysql-connector-java-5.1.30.jar: org.jooq.util.GenerationTool library.xml

注1: jar 包都要和本地的版本对应,mysql-connector 也要和 mysql 对应,我数据库是 5.7.24,使用 5.1.48 版本的 connector 报 ClassNotFound 错误,使用 5.1.30 就可以

运行命令看到输出

...
信息: Synthetic primary keys   : 0 (0 included, 0 excluded)
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Overriding primary keys  : 1 (0 included, 1 excluded)
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Generating table         : Author.java [input=author, output=author, pk=KEY_author_PRIMARY]
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Tables generated         : Total: 712.006ms
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Generating table references
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Table refs generated     : Total: 724.683ms, +12.676ms
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Generating Keys
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Keys generated           : Total: 728.338ms, +3.654ms
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Generating table records
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Generating record        : AuthorRecord.java
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Table records generated  : Total: 742.384ms, +14.046ms
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Domains fetched          : 0 (0 included, 0 excluded)
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Generation finished: library: Total: 743.337ms, +0.953ms
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息:
六月 29, 2021 11:16:00 上午 org.jooq.tools.JooqLogger info
信息: Removing excess files

连接数据库

创建一个测试类,一个标准的 JDBC MySQL 连接代码

package zone.yiqing.learnjooq;

import java.sql.Connection;
import java.sql.DriverManager;

/**
 * @author yiqing.zhang
 * @date 2021-06-29.
 */
public class Main {

  public static void main(String[] args) {
    String userName = "root";
    String password = "123456";
    String url = "jdbc:mysql://localhost:3306/library";

    // Connection is the only JDBC resource that we need
    // PreparedStatement and ResultSet are handled by jOOQ, internally
    try (Connection conn = DriverManager.getConnection(url, userName, password)) {
      // ...
    }
    // For the sake of this tutorial, let's keep exception handling simple
    catch (Exception e) {
      e.printStackTrace();
    }
  }

}

查询

使用 jOOQ 的 DSL 构建一个简单查询

1 2	DSLContext create = DSL.using(conn, SQLDialect.MYSQL); Result<Record> result = create.select().from(AUTHOR).fetch();

传入Connection连接对象、数据方言得到一个DSLContext的实例，然后使用DSL对象查询得到一个Result对象。

注意：DSLContext不会主动关闭连接，需要我们手动关闭。

输出

得到结果后,使用迭代器打印结果

for (Record r : result) {
  Integer id = r.getValue(AUTHOR.ID);
  String firstName = r.getValue(AUTHOR.FIRST_NAME);
  String lastName = r.getValue(AUTHOR.LAST_NAME);
  System.out.println("ID: " + id + " first name: " + firstName + " last name: " + lastName);
}

结果我一看咋啥都没有,原来是没有插入数据

1	INSERT INTO author(id,first_name,last_name) VALUES(1,'yiqing','zhang');

重新运行

六月 29, 2021 11:41:22 上午 org.jooq.tools.JooqLogger info
信息: 
                                      
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@  @@        @@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@        @@@@@@@@@@
@@@@@@@@@@@@@@@@  @@  @@    @@@@@@@@@@
@@@@@@@@@@  @@@@  @@  @@    @@@@@@@@@@
@@@@@@@@@@        @@        @@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@        @@        @@@@@@@@@@
@@@@@@@@@@    @@  @@  @@@@  @@@@@@@@@@
@@@@@@@@@@    @@  @@  @@@@  @@@@@@@@@@
@@@@@@@@@@        @@  @  @  @@@@@@@@@@
@@@@@@@@@@        @@        @@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@  @@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@  Thank you for using jOOQ 3.9.5
                                      
ID: 1 first name: yiqing last name: zhang

成功!

探索

好吧这就是第七步,强行加的一步,附上第七步原文

jOOQ has grown to be a comprehensive SQL library. For more information, please consider the documentation:

https://www.jooq.org/learn

… explore the Javadoc:

https://www.jooq.org/javadoc/latest/

… or join the news group:

https://groups.google.com/forum/#!forum/jooq-user

This tutorial is the courtesy of Ikai Lan. See the original source here:

http://ikaisays.com/2011/11/01/getting-started-with-jooq-a-tutorial/

进阶

配置生成 dao,pojo,interface

修改 library.xml 文件中的 generate 标签

<!-- 配置生成 dao,interface,pojo-->
<generate>
  <daos>true</daos>
  <interfaces>true</interfaces>
  <pojos>true</pojos>
</generate>

重新使用 maven compile 一下即可

生成目录介绍

DefaultCatalog: 一些常量,平时用不到
Library(名称不定,根据自己的库名): 数据库常量,包含库中表的描述
Keys: 表中的主键,唯一索引等
Tables:表的常量
tables: 文件夹,包含了我们应该使用的操作
- interface:定义了各种字段的 get,set 等等
  - 可以提高pojo 和 records 之间的转换性能
- pojos: 一些表对象,实现了定义的接口
- records: 表操作对象,包含字段 get,set 方法

CRUD

R

public class SelectDemo {

  public static void main(String[] args) {
    selectDemo();
  }

  public static void selectDemo() {
    DSLContext dslContext = DslContextConfig.getDslContext();
    Result<Record> result = dslContext.select().from(AUTHOR)
        .where(AUTHOR.FIRST_NAME.eq("yiqing")).fetch();
    System.out.println(result);

    Result<Record1<Integer>> result1 = dslContext.selectCount().from(AUTHOR).fetch();
    System.out.println(result1);

    Result<Record1<String>> result2 = dslContext.selectDistinct(AUTHOR.FIRST_NAME).from(AUTHOR)
        .fetch();
    System.out.println(result2);

    Result<Record> result3 = dslContext.select().from(AUTHOR).where(AUTHOR.FIRST_NAME.like("%y%"))
        .fetch();
    System.out.println(result3);

    dslContext.select(AUTHOR.ID,AUTHOR.FIRST_NAME)
        .from(AUTHOR)
        .orderBy(AUTHOR.ID.asc())
        .limit(2)
        .offset(2)
        .fetch()
        .forEach(System.out::println);
  }
}

C

public class InsertDemo {

  public static void main(String[] args) {
    insert();
  }

  public static void insert(){
    DSLContext dslContext = DslContextConfig.getDslContext();

    // 方法 1
    try{
      dslContext.insertInto(AUTHOR,AUTHOR.ID,AUTHOR.FIRST_NAME,AUTHOR.LAST_NAME)
          .values(4,"mazi","wang")
          .execute();
    }catch (Exception e){}


    // 方法 2
    dslContext.insertInto(AUTHOR)
        .set(AUTHOR.ID, 5)
        .set(AUTHOR.FIRST_NAME, "si")
        .set(AUTHOR.LAST_NAME, "wang")
        .execute();
  }
}

U

public class UpdateDemo {

  public static void main(String[] args) {
    update();
  }

  public static void update(){
    DSLContext dslContext = DslContextConfig.getDslContext();
    dslContext.update(AUTHOR).set(AUTHOR.FIRST_NAME,"san2")
        .where(AUTHOR.FIRST_NAME.eq("san"))
        .execute();

    dslContext.update(AUTHOR)
        .set(AUTHOR.FIRST_NAME,
            select(AUTHOR.FIRST_NAME).from(AUTHOR).where(AUTHOR.LAST_NAME.eq("li")))
        .where(AUTHOR.LAST_NAME.eq("wang"))
        .execute();
  }
}

D

public class DelectDemo {

  public static void main(String[] args) {
    delete();
  }

  public static void delete() {
    DSLContext dslContext = DslContextConfig.getDslContext();
    dslContext.delete(AUTHOR)
        .where(AUTHOR.LAST_NAME.eq("li"))
        .execute();
  }
}

将结果封装成对应的类

public class ResultHandleDemo {

  public static void main(String[] args) {
    resultHandle();
  }
  public static void resultHandle(){
    DSLContext dslContext = DslContextConfig.getDslContext();
    List<Author> authors = dslContext.select()
        .from(AUTHOR)
        .where(AUTHOR.LAST_NAME.eq("zhang"))
        .fetch(r -> r.into(Author.class));
    System.out.println(authors);

    List<Author> into = dslContext.select()
        .from(AUTHOR)
        .where(AUTHOR.LAST_NAME.eq("zhang"))
        .fetchInto(Author.class);
    System.out.println(into);
  }
}

Transaction

public class TransactionDemo {

  public static void main(String[] args) {
    transaction();
  }

  private static void transaction() {
    DSLContext dslContext = DslContextConfig.getDslContext();
    dslContext.transaction(configuration -> {
      AuthorRecord peng = dslContext.insertInto(AUTHOR)
          .set(AUTHOR.ID, 6)
          .set(AUTHOR.FIRST_NAME, "6")
          .set(AUTHOR.LAST_NAME, "peng")
          .returning()
          .fetchOne();
    });
  }
}

执行可见正常插入

插入一个错误运算int i=1/0;

可见报错并且没有插入

注 2:一般来说,平时很少用 jOOQ 的事务,平时常结合第三方如 spring 进行事务管理

本文链接： http://yiiiqing.github.io/2021/06/28/jOOQ%E5%85%A5%E9%97%A8/

版权声明： 本博客所有文章除特别声明外，均采用 CC BY 4.0 CN协议许可协议。转载请注明出处！

YiqingWeb Developer

一位打工人