快捷導(dǎo)航

在springboot中如何集成clickhouse進(jìn)行讀寫(xiě)操作

更新時(shí)間：2024年11月18日 09:41:08 作者：oNuoyi

本文介紹了在Spring Boot中集成ClickHouse的步驟,包括引入依賴(lài)、配置數(shù)據(jù)源、編寫(xiě)實(shí)體類(lèi)和Mapper類(lèi)進(jìn)行CRUD操作,特別提到批量插入時(shí)需要在SQL語(yǔ)句中添加`FORMAT`以避免錯(cuò)誤,在實(shí)際應(yīng)用中,與MySQL的操作類(lèi)似,只需將ClickHouse當(dāng)作MySQL使用

1、引入依賴(lài)

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.3.4</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!--升級(jí) druid驅(qū)動(dòng) 1.1.10支持ClickHouse-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.13</version>
        </dependency>

2、編寫(xiě)數(shù)據(jù)源配置

@Configuration
public class DruidConfig {

    @Bean
    public DataSource dataSource(){
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setUrl("jdbc:clickhouse://localhost:8123/test");
        dataSource.setInitialSize(10);
        dataSource.setMaxActive(100);
        dataSource.setMinIdle(10);
        dataSource.setMaxWait(-1);
        return dataSource;
    }

}

3、編寫(xiě)表實(shí)體類(lèi)

和mysql一模一樣寫(xiě)法，對(duì)應(yīng)的表我通過(guò)DBeaver已經(jīng)創(chuàng)建好了

package cn.yufire.sync.sls.getway.logs.pojo;

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.*;

import java.io.Serializable;

@Builder
@AllArgsConstructor
@NoArgsConstructor
@TableName(value = "getway_logs")
@Data
public class GetwayLogs implements Serializable {
    /**
     * id
     */
    @TableField(value = "id")
    private Long id;

    /**
     * 接口名稱(chēng)：網(wǎng)關(guān)上定義的名稱(chēng)
     */
    @TableField(value = "api_name")
    private String apiName;

    /**
     * 響應(yīng)體
     */
    @TableField(value = "response_body")
    private String responseBody;

    /**
     * 調(diào)用環(huán)境：TEST、RELEASE、PRE
     */
    @TableField(value = "api_stage_name")
    private String apiStageName;

    /**
     * 錯(cuò)誤碼
     */
    @TableField(value = "error_code")
    private String errorCode;

    /**
     * 請(qǐng)求類(lèi)型
     */
    @TableField(value = "http_method")
    private String httpMethod;

    /**
     * 接口請(qǐng)求地址
     */
    @TableField(value = "api_path")
    private String apiPath;

    /**
     * 接口請(qǐng)求全地址
     */
    @TableField(value = "api_full_path")
    private String apiFullPath;

    /**
     * 請(qǐng)求時(shí)間
     */
    @TableField(value = "request_time")
    private String requestTime;

    /**
     * 請(qǐng)求體
     */
    @TableField(value = "request_body")
    private String requestBody;

    /**
     * 網(wǎng)關(guān)請(qǐng)求阿里云創(chuàng)建
     */
    @TableField(value = "getway_request_id")
    private String getwayRequestId;

    /**
     * 阿里云網(wǎng)關(guān)應(yīng)用id
     */
    @TableField(value = "getway_app_id")
    private String getwayAppId;

    /**
     * 請(qǐng)求協(xié)議，HTTP、HTTPS、...
     */
    @TableField(value = "request_protocol")
    private String requestProtocol;

    /**
     * 客戶(hù)端調(diào)用產(chǎn)生的隨機(jī)字符串
     */
    @TableField(value = "client_nonce")
    private String clientNonce;

    /**
     * 網(wǎng)關(guān)應(yīng)用名稱(chēng)
     */
    @TableField(value = "getway_app_name")
    private String getwayAppName;

    /**
     * 網(wǎng)關(guān)分組id
     */
    @TableField(value = "getway_group_id")
    private String getwayGroupId;

    /**
     * 客戶(hù)端ip
     */
    @TableField(value = "client_ip")
    private String clientIp;

    /**
     * 網(wǎng)關(guān)綁定域名
     */
    @TableField(value = "getway_bind_domain")
    private String getwayBindDomain;

    /**
     * 請(qǐng)求體大小
     */
    @TableField(value = "request_size")
    private Integer requestSize;

    /**
     * 響應(yīng)體大小
     */
    @TableField(value = "response_size")
    private Integer responseSize;

    /**
     * 后端應(yīng)用響應(yīng)HTTP狀態(tài)碼
     */
    @TableField(value = "app_response_code")
    private Integer appResponseCode;

    /**
     * 分組名稱(chēng)
     * */
    @TableField(value = "apiGroupName")
    private String apiGroupName;
}

4、創(chuàng)建一個(gè)mapper類(lèi)進(jìn)行增刪改查

因?yàn)槲沂褂胏lickhouse只需要批量插入，所以就寫(xiě)了一個(gè)批量插入的sql，當(dāng)然mybatis-plus也有自帶的批量插入的方法，但是不是一條sql執(zhí)行的，而是通過(guò)批量執(zhí)行多條 SQL 語(yǔ)句來(lái)實(shí)現(xiàn)的，所以就手寫(xiě)了一個(gè)批次插入的sql,這里有一個(gè)坑，批量插入clickhouse會(huì)報(bào)錯(cuò)，單條插入沒(méi)問(wèn)題，百度了發(fā)現(xiàn)批量插入各種小問(wèn)題，需要在 Values前加一個(gè)FORMAT ，即 insert into x(xx,xx) FORMAT Values (),處理后就沒(méi)有報(bào)錯(cuò)了

package cn.yufire.sync.sls.getway.logs.mapper;

import cn.yufire.sync.sls.getway.logs.pojo.GetwayLogs;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.apache.ibatis.annotations.Insert;

import java.util.List;

public interface GetwayLogsMapper extends BaseMapper<GetwayLogs> {

    /**
     * 批量插入網(wǎng)關(guān)日志
     *
     * @param list 數(shù)據(jù)
     * @return
     */
    @Insert("<script>insert into getway_logs(" +
            "api_name," +
            "response_body," +
            "api_stage_name," +
            "error_code," +
            "http_method," +
            "api_path," +
            "api_full_path," +
            "request_time," +
            "request_body," +
            "getway_request_id," +
            "getway_app_id," +
            "request_protocol," +
            "client_nonce," +
            "getway_app_name," +
            "getway_group_id," +
            "client_ip," +
            "getway_bind_domain," +
            "request_size," +
            "response_size," +
            "app_response_code" +
            ") FORMAT Values " +
            " <foreach collection=\"list\" item=\"item\" index=\"index\" separator=\",\">\n" +
            "     (" +
            "#{item.apiName}," +
            "#{item.responseBody}," +
            "#{item.apiStageName}," +
            "#{item.errorCode}," +
            "#{item.httpMethod}," +
            "#{item.apiPath}," +
            "#{item.apiFullPath}," +
            "#{item.requestTime}," +
            "#{item.requestBody}," +
            "#{item.getwayRequestId}," +
            "#{item.getwayAppId}," +
            "#{item.requestProtocol}," +
            "#{item.clientNonce}," +
            "#{item.getwayAppName}," +
            "#{item.getwayGroupId}," +
            "#{item.clientIp}," +
            "#{item.getwayBindDomain}," +
            "#{item.requestSize}," +
            "#{item.responseSize}," +
            "#{item.appResponseCode}" +
            ")\n" +
            "        </foreach>" +

            "</script>")
    Integer batchInsert(List<GetwayLogs> list);


}

在業(yè)務(wù)中調(diào)用

@Autowired
private GetwayLogsMapper getwayLogsMapper;

log.info("批量插入至數(shù)據(jù)庫(kù)中...,是否添加成功:{}", getwayLogsMapper.batchInsert(logs));

可以看到增刪改查操作和操作mysql的一模一樣，也就是說(shuō)給clickhouse當(dāng)成mysql用就行

在springboot中集成clickhouse中也遇到了一些報(bào)錯(cuò)

ClickHouse exception, code: 1002

使用了clickhouse的依賴(lài)和jpa依賴(lài)總是跑不起來(lái),一直報(bào)沒(méi)有驅(qū)動(dòng)，給了驅(qū)動(dòng)也不對(duì)

clickhouse集成springboot報(bào)錯(cuò)Unable to determine Dialect to use [name=ClickHouse, majorVersion=22]; user must register resolver or explicitly set 'hibernate.dialect'

百度了各種最后看到這個(gè)，直接給clickhouse的依賴(lài)和jpa的依賴(lài)去掉就給clickhouse當(dāng)成mysql結(jié)果就正常了