当前位置：首页 > article >正文

SpringBoot+MyBatis整合ClickHouse实践

article 2024/12/4 15:08:06

整合Spring Boot、MyBatis和ClickHouse可以让你使用Java开发的应用程序高效地与ClickHouse数据库进行交互。以下是一个基本的步骤指南，帮助你完成这个整合过程：

1. 添加依赖

首先，在你的pom.xml文件中添加必要的Maven依赖。你需要引入Spring Boot Starter、MyBatis Spring Boot Starter以及ClickHouse JDBC驱动。

<dependencies>
    <!-- Spring Boot Starter -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>

    <!-- MyBatis Spring Boot Starter -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.0</version> <!-- 请根据需要选择版本 -->
    </dependency>

    <!-- ClickHouse JDBC Driver -->
    <dependency>
        <groupId>ru.yandex.clickhouse</groupId>
        <artifactId>clickhouse-jdbc</artifactId>
        <version>0.3.2</version> <!-- 请根据需要选择版本 -->
    </dependency>
    
    <!-- 其他依赖项 -->
</dependencies>

2. 配置数据源

在application.properties或application.yml中配置数据源以连接到ClickHouse。

application.properties:

# ClickHouse 数据库连接配置
spring.datasource.url=jdbc:clickhouse://localhost:8123/default
spring.datasource.username=your_username
spring.datasource.password=your_password
spring.datasource.driver-class-name=ru.yandex.clickhouse.ClickHouseDriver

# MyBatis 配置
mybatis.type-aliases-package=com.example.demo.model
mybatis.mapper-locations=classpath:mapper/*.xml

application.yml:

spring:
  datasource:
    url: jdbc:clickhouse://localhost:8123/default
    username: your_username
    password: your_password
    driver-class-name: ru.yandex.clickhouse.ClickHouseDriver

mybatis:
  type-aliases-package: com.example.demo.model
  mapper-locations: classpath:mapper/*.xml

3. 创建实体类（Entity）

为你的表创建相应的Java实体类。例如，如果你有一个名为users的表，你可以创建一个User实体类。

package com.example.demo.model;

public class User {
    private Long id;
    private String name;
    private Integer age;

    // Getters and Setters
}

4. 创建Mapper接口

使用MyBatis的注解或者XML映射文件来定义SQL语句。这里我们使用XML映射文件作为例子。

UserMapper.java:

package com.example.demo.mapper;

import org.apache.ibatis.annotations.Mapper;
import com.example.demo.model.User;

import java.util.List;

@Mapper
public interface UserMapper {
    List<User> findAll();
    void insert(User user);
}

resources/mapper/UserMapper.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.example.demo.mapper.UserMapper">
    <select id="findAll" resultType="com.example.demo.model.User">
        SELECT * FROM users
    </select>

    <insert id="insert" parameterType="com.example.demo.model.User">
        INSERT INTO users (id, name, age) VALUES (#{id}, #{name}, #{age})
    </insert>
</mapper>

5. 编写服务层代码

编写服务层代码来调用Mapper接口的方法。

package com.example.demo.service;

import com.example.demo.mapper.UserMapper;
import com.example.demo.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public List<User> getAllUsers() {
        return userMapper.findAll();
    }

    public void saveUser(User user) {
        userMapper.insert(user);
    }
}

6. 使用控制器测试

最后，创建一个简单的控制器来测试你的服务是否正常工作。

package com.example.demo.controller;

import com.example.demo.model.User;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/api/users")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping
    public List<User> getUsers() {
        return userService.getAllUsers();
    }

    @PostMapping
    public void createUser(@RequestBody User user) {
        userService.saveUser(user);
    }
}