Java根據前端返回的欄位名進行查詢資料的方法

TechSynapse發表於2024-11-22

在Java後端開發中,根據前端返回的欄位名動態查詢資料庫是一種常見的需求。這種需求通常透過使用反射和動態SQL來實現。下面是一個完整的程式碼示例,它展示瞭如何根據前端返回的欄位名動態查詢資料庫中的資料。

一、根據前端返回的欄位名動態查詢資料庫中的資料示例

1.準備工作

(1)資料庫設定:

  • 假設我們有一個名為users的表,結構如下:

    CREATE TABLE users (
        id INT PRIMARY KEY AUTO_INCREMENT,
        name VARCHAR(255),
        email VARCHAR(255),
        age INT
    );
    
  • 插入一些測試資料:

    INSERT INTO users (name, email, age) VALUES ('Alice', 'alice@example.com', 30);
    INSERT INTO users (name, email, age) VALUES ('Bob', 'bob@example.com', 25);
    

(2)依賴庫:

  • 使用MySQL作為資料庫。
  • 使用JDBC進行資料庫連線。
  • 使用Spring Boot簡化配置和依賴管理(但示例中不涉及複雜的Spring框架功能,只關注核心邏輯)。

2.核心程式碼

(1)資料庫連線配置

首先,在src/main/resources目錄下建立一個application.properties檔案,配置資料庫連線資訊:

spring.datasource.url=jdbc:mysql://localhost:3306/your_database_name
spring.datasource.username=your_database_username
spring.datasource.password=your_database_password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

(2) 動態查詢工具類

建立一個工具類DynamicQueryUtil,用於根據欄位名生成動態SQL並執行查詢:

import java.sql.*;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
 
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
 
@Component
public class DynamicQueryUtil {
 
    @Value("${spring.datasource.url}")
    private String url;
 
    @Value("${spring.datasource.username}")
    private String username;
 
    @Value("${spring.datasource.password}")
    private String password;
 
    public List<Map<String, Object>> queryByFields(List<String> fields, String tableName) {
        List<Map<String, Object>> results = new ArrayList<>();
        String sql = "SELECT " + String.join(", ", fields) + " FROM " + tableName;
 
        try (Connection conn = DriverManager.getConnection(url, username, password);
             Statement stmt = conn.createStatement();
             ResultSet rs = stmt.executeQuery(sql)) {
 
            while (rs.next()) {
                Map<String, Object> row = new HashMap<>();
                for (String field : fields) {
                    row.put(field, rs.getObject(field));
                }
                results.add(row);
            }
 
        } catch (SQLException e) {
            e.printStackTrace();
        }
 
        return results;
    }
}

(3)控制器類

建立一個控制器類UserController,用於接收前端請求並呼叫動態查詢工具類:

import java.util.List;
import java.util.Map;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
 
@RestController
@RequestMapping("/api/users")
public class UserController {
 
    @Autowired
    private DynamicQueryUtil dynamicQueryUtil;
 
    @GetMapping("/query")
    public List<Map<String, Object>> queryUsers(@RequestParam List<String> fields) {
        return dynamicQueryUtil.queryByFields(fields, "users");
    }
}

(4)啟動類

建立一個Spring Boot啟動類:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
@SpringBootApplication
public class DynamicQueryApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(DynamicQueryApplication.class, args);
    }
}

3.執行示例

(1)啟動Spring Boot應用。

(2)使用瀏覽器或Postman等工具傳送GET請求到http://localhost:8080/api/users/query?fields=name,email

(3)響應結果應類似於:

[
    {
        "name": "Alice",
        "email": "alice@example.com"
    },
    {
        "name": "Bob",
        "email": "bob@example.com"
    }
]

4.注意事項

(1)安全性:在實際應用中,需要對前端傳入的欄位名和表名進行校驗,防止SQL隱碼攻擊。

(2)效能:頻繁拼接SQL字串並建立連線可能對效能有影響,應考慮使用連線池和快取機制。

(3)擴充套件性:可以使用更高階的ORM框架(如MyBatis或Hibernate)來簡化資料庫操作,並增強安全性和效能。

二、更詳細的程式碼示例

下面是一個更詳細的程式碼示例,它包含了完整的Spring Boot專案結構,並詳細解釋了每一步。這個示例將展示如何建立一個簡單的Spring Boot應用,該應用能夠根據前端請求的欄位名動態地查詢資料庫中的資料。

1.專案結構

dynamic-query-example
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── example
│   │   │           └── dynamicquery
│   │   │               ├── DynamicQueryApplication.java
│   │   │               ├── controller
│   │   │               │   └── UserController.java
│   │   │               ├── service
│   │   │               │   └── UserService.java
│   │   │               ├── service.impl
│   │   │               │   └── UserServiceImpl.java
│   │   │               ├── util
│   │   │               │   └── DynamicQueryUtil.java
│   │   │               └── model
│   │   │                   └── User.java
│   │   ├── resources
│   │   │   ├── application.properties
│   │   │   └── data.sql  (可選,用於初始化資料庫)
│   └── test
│       └── java
│           └── com
│               └── example
│                   └── dynamicquery
│                       └── DynamicQueryApplicationTests.java
└── pom.xml

2.pom.xml

首先,確保我們的pom.xml包含了必要的依賴項,如Spring Boot Starter Web和MySQL Connector。

<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>com.example</groupId>
    <artifactId>dynamic-query-example</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>dynamic-query-example</name>
    <description>Demo project for Spring Boot</description>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.0</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

3.application.properties

配置資料庫連線資訊。

spring.datasource.url=jdbc:mysql://localhost:3306/your_database_name?useSSL=false&serverTimezone=UTC
spring.datasource.username=your_database_username
spring.datasource.password=your_database_password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect

4.資料模型 User.java

定義一個簡單的User類,它對應資料庫中的users表。

package com.example.dynamicquery.model;
 
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
 
@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String email;
    private Integer age;
 
    // Getters and Setters
}

5.動態查詢工具類 DynamicQueryUtil.java

這個類將負責根據欄位名生成SQL並執行查詢。注意,這個示例中我們不會直接使用它,而是用JPA來演示更現代的方法。但為了完整性,我還是提供了這個類的程式碼。

java複製程式碼

// ... (省略了DynamicQueryUtil類的程式碼,因為它在這個示例中不會被直接使用)

注意:在實際應用中,我們應該使用JPA的EntityManager或Spring Data JPA的JpaRepository來執行動態查詢,而不是直接使用JDBC。下面的UserServiceImpl類將展示如何使用JPA來實現動態查詢。

6. 服務介面 UserService.java

定義一個服務介面。

package com.example.dynamicquery.service;
 
import java.util.List;
import java.util.Map;
 
public interface UserService {
    List<Map<String, Object>> findUsersByFields(List<String> fields);
}

7.服務實現類 UserServiceImpl.java

首先,我們假設 User 類已經存在,並且包含了 id, name, email, 和 age 屬性,以及相應的getter和setter方法。這裡我們不會完整地展示 User 類,因為它通常很簡單,只是包含一些基本的欄位和JPA註解。

接下來,我們完善 User_ 類,使其能夠作為JPA元模型的模擬。在實際專案中,我們會使用JPA提供的元模型生成器來自動生成這些類。

以下是完整的 UserServiceImpl.java 程式碼,包括一個簡化的 User 類定義和完善的 User_ 類:

package com.example.dynamicquery.model;
 
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
 
@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String email;
    private Integer age;
 
    // Getters and Setters
    public Long getId() {
        return id;
    }
 
    public void setId(Long id) {
        this.id = id;
    }
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
    public String getEmail() {
        return email;
    }
 
    public void setEmail(String email) {
        this.email = email;
    }
 
    public Integer getAge() {
        return age;
    }
 
    public void setAge(Integer age) {
        this.age = age;
    }
}
 
---
 
package com.example.dynamicquery.service.impl;
 
import com.example.dynamicquery.model.User;
import com.example.dynamicquery.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
 
import javax.persistence.EntityManager;
import javax.persistence.TypedQuery;
import javax.persistence.criteria.*;
import java.util.*;
 
@Service
public class UserServiceImpl implements UserService {
 
    @Autowired
    private EntityManager entityManager;
 
    @Override
    public List<Map<String, Object>> findUsersByFields(List<String> fields) {
        if (fields == null || fields.isEmpty()) {
            throw new IllegalArgumentException("Fields list cannot be null or empty");
        }
 
        CriteriaBuilder cb = entityManager.getCriteriaBuilder();
        CriteriaQuery<Object[]> cq = cb.createQuery(Object[].class);
        Root<User> user = cq.from(User.class);
 
        List<Selection<?>> selections = new ArrayList<>();
        for (String field : fields) {
            switch (field) {
                case "id":
                    selections.add(user.get("id"));
                    break;
                case "name":
                    selections.add(user.get("name"));
                    break;
                case "email":
                    selections.add(user.get("email"));
                    break;
                case "age":
                    selections.add(user.get("age"));
                    break;
                default:
                    throw new IllegalArgumentException("Unknown field: " + field);
            }
        }
 
        cq.select(cb.array(selections.toArray(new Selection[0])));
        TypedQuery<Object[]> query = entityManager.createQuery(cq);
 
        List<Object[]> results = query.getResultList();
        List<Map<String, Object>> userList = new ArrayList<>();
        for (Object[] result : results) {
            Map<String, Object> userMap = new HashMap<>();
            for (int i = 0; i < fields.size(); i++) {
                userMap.put(fields.get(i), result[i]);
            }
            userList.add(userMap);
        }
 
        return userList;
    }
 
    // 靜態內部類用於模擬JPA的元模型(Metamodel),實際專案中應使用自動生成的元模型
    // 注意:在實際專案中,我們不需要手動編寫這個類,JPA提供者會自動為我們生成。
    // 這裡只是為了演示目的而包含它。
    private static class User_ {
        // 這些欄位是模擬的,實際中應由JPA工具自動生成
        public static final SingularAttribute<User, Long> id = mockAttribute("id");
        public static final SingularAttribute<User, String> name = mockAttribute("name");
        public static final SingularAttribute<User, String> email = mockAttribute("email");
        public static final SingularAttribute<User, Integer> age = mockAttribute("age");
 
        // 模擬方法,實際中不存在
        private static <T, X> SingularAttribute<T, X> mockAttribute(String name) {
            return null; // 實際返回的是由JPA提供者生成的SingularAttribute例項
        }
    }
 
    // 注意:上面的mockAttribute方法是為了編譯透過而新增的,實際程式碼中應該移除。
    // 在實際專案中,我們應該直接使用JPA提供的元模型類,而不是這個模擬的User_類。
    // 由於這個示例是為了演示動態查詢,我們保留了User_類,但在實際應用中應忽略它。
}

重要說明

(1)在實際專案中,我們應該使用JPA提供者(如Hibernate)自動生成的元模型類,而不是上面的 User_ 類。這些類通常位於與實體類相同的包中,並且以 _ 字尾命名(例如,User_)。

(2)上面的 mockAttribute 方法是為了編譯透過而新增的,實際程式碼中應該移除。這個方法在實際專案中不存在,因為它只是模擬了JPA元模型的行為。

(3)在呼叫 user.get(...) 時,我們直接使用了字串屬性名(例如 "id", "name" 等)。在實際專案中,我們應該使用JPA元模型類中的靜態欄位來引用這些屬性,以提高型別安全性和重構能力。例如,我們應該使用 User_.id 而不是 "id"。但是,由於我們在這個示例中模擬了元模型,所以我們直接使用了字串。

(4)在實際專案中,我們可能還需要處理一些額外的邊界情況,比如欄位名的大小寫敏感性、空值處理等。

(5)考慮到效能和安全性,動態查詢應該謹慎使用,並確保傳入的欄位名是經過驗證和授權的。

三、內建的http.server模組來建立一個基本的HTTP伺服器

這裡將以Python語言編寫一個簡單的Web伺服器為例,使用內建的http.server模組來建立一個基本的HTTP伺服器。這個示例將展示如何啟動一個伺服器,並在特定埠上監聽請求,然後返回一個簡單的HTML響應。

1.程式碼示例

# 匯入必要的模組
from http.server import SimpleHTTPRequestHandler, HTTPServer
 
# 定義一個自定義的請求處理器類,繼承自SimpleHTTPRequestHandler
class MyRequestHandler(SimpleHTTPRequestHandler):
    def do_GET(self):
        # 設定響應狀態碼
        self.send_response(200)
        
        # 設定響應頭
        self.send_header('Content-type', 'text/html')
        self.end_headers()
        
        # 準備響應體
        response_body = """
        <!DOCTYPE html>
        <html>
        <head>
            <title>Simple Web Server</title>
        </head>
        <body>
            <h1>Hello, World!</h1>
            <p>This is a simple web server running on Python.</p>
        </body>
        </html>
        """
        
        # 傳送響應體
        self.wfile.write(response_body.encode('utf-8'))
 
# 定義伺服器的地址和埠
server_address = ('', 8080)
 
# 建立HTTP伺服器物件,傳入伺服器地址和請求處理器類
httpd = HTTPServer(server_address, MyRequestHandler)
 
# 列印伺服器啟動資訊
print("Starting httpd server on port 8080...")
 
# 啟動伺服器,開始監聽請求
httpd.serve_forever()

2.程式碼說明:

(1)匯入模組:首先,我們匯入了SimpleHTTPRequestHandlerHTTPServer模組,這兩個模組是Python標準庫中用於建立HTTP伺服器的。

(2)定義請求處理器:我們建立了一個名為MyRequestHandler的類,繼承自SimpleHTTPRequestHandler。在這個類中,我們重寫了do_GET方法,用於處理GET請求。

(3)設定響應:在do_GET方法中,我們首先設定了響應的狀態碼(200表示成功),然後設定了響應頭(指定內容型別為HTML),最後準備了響應體(一個簡單的HTML頁面)。

(4)啟動伺服器:我們定義了伺服器的地址和埠(這裡監聽所有介面的8080埠),然後建立了HTTPServer物件,並傳入伺服器地址和我們自定義的請求處理器類。最後,呼叫serve_forever方法啟動伺服器,使其開始監聽請求。

3.執行程式碼:

將上述程式碼儲存為一個Python檔案(例如simple_server.py),然後在命令列中執行該檔案:

bash複製程式碼

python simple_server.py

伺服器啟動後,我們可以在瀏覽器中訪問http://localhost:8080,我們將看到一個簡單的HTML頁面,顯示“Hello, World!”和一條訊息說明這是一個簡單的Web伺服器。

這個示例展示瞭如何使用Python標準庫中的模組建立一個基本的Web伺服器,並處理HTTP GET請求。根據需要,我們可以進一步擴充套件這個示例,新增更多的請求處理方法,處理POST請求,或者從請求中獲取引數等。

相關文章