查询 DB 并以 Json 格式返回结果的通用 Java 方法

Posted 2023-02-24

【中文标题】查询 DB 并以 Json 格式返回结果的通用 Java 方法

【英文标题】：General Java Method that Queries DB and Returns Results in Json Format

【发布时间】：2016-05-10 03:05:27

【问题描述】：

我正在寻找的东西对我来说似乎很简单，但我的谷歌搜索失败了。

我想要一个允许我运行任何查询并以 json 格式获取结果的方法。

诀窍是我不希望结果需要 java 对象作为流程的一部分（DTO、VO 等）。

有什么快速/简单/干净的方法吗？

【参考方案1】：

杰克逊有一些很好的方法。 this answer 中的一些示例应该会为您带来奇迹。

或者，如果您无法联系到 Jackson，您可以查看 this

【讨论】：

我将在您提供的答案参考中尝试 Phoenix 的解决方案。它使用Apache-DBUtils and the Gson library，如果可行，我会接受，因为他的回答很干净。

已接受答案。我发布了另一个答案，详细说明了一个简单的实现。

【参考方案2】：

我通常和我的同事一起这样做的方式是我们创建线束或控制器类，它通常指向 SQL 连接。线束的工作是将您的信息从 SQL 数据库提取到您的 json 文件中。但是，您需要创建一个存储过程，并且需要在 SQL Connection 类中调用该存储过程。

【参考方案3】：

我认为你有两个选择：

您可以使用更通用的数据结构在 java 中显示您的 JSON 有效负载。类似于Map 实例。 您可以创建一个类来为您的结果集建模，并创建模型的实例来存储有效负载。

【参考方案4】：

非常有趣的问题。我不确定是否有任何库可以直接执行此操作。但我们有两种选择。

通过 hibernate 和 Jackson 库，我们可以在 JSON 数据。 我们可以从 SQL 生成实体，并且我们可以使用该实体 转换成 JSON 对象。

我们可以让 DataAccessLayer 可以通用地获取数据。实体转Json对象，需要提供具体实体类（单独的JSON生成类）中的逻辑。

【参考方案5】：

我接受了 DominicEU 的回答，因为它为我提供了让事情正常进行所需的一切。凤凰城在链接中的回答很好，但仍然缺乏一些细节。下面显示了 pom 和一个工作示例...（您可能需要重新设计连接内容以实现真正的实现）：

Java 代码：

import com.google.gson.Gson;
import org.apache.commons.dbutils.DbUtils;
import org.apache.commons.dbutils.QueryRunner;
import org.apache.commons.dbutils.handlers.MapListHandler;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.util.List;
import java.util.Map;

public class DBUtil 

    public String resultSetToJson(String query) 
        Connection connection = null;
        List<Map<String, Object>> listOfMaps = null;

        try 
            Class.forName("com.mysql.jdbc.Driver");
            connection = DriverManager.getConnection("jdbc:mysql://server:3306/databasename?user=username&password=password");
         catch (Exception ex) 
            System.err.println("***exception trying to connect***");
            ex.printStackTrace();
        

        try 
            QueryRunner queryRunner = new QueryRunner();
            listOfMaps = queryRunner.query(connection, query, new MapListHandler());
         catch (SQLException se) 
            throw new RuntimeException("Couldn't query the database.", se);
         finally 
            DbUtils.closeQuietly(connection);
        
        return new Gson().toJson(listOfMaps);
    

Maven pom：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>groupId</groupId>
    <artifactId>dbgeneric</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>commons-dbutils</groupId>
            <artifactId>commons-dbutils</artifactId>
            <version>1.6</version>
        </dependency>
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.5</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.6</version>
        </dependency>
    </dependencies>

</project>