Golang 读取并解析SQL文件的实现方法_Golang

一、背景

在数据库开发与维护过程中，我们经常需要执行大量的sql语句。有时，这些sql语句会被保存在一个文件中，以便于批量执行。为了方便地在go语言中处理这些sql文件，我们可以编写一个函数来读取并解析sql文件中的语句。

二、实现思路

打开sql文件。
逐行读取文件内容。
过滤掉注释和空行。
拼接sql语句，以分号（;）为结束符。
将拼接好的sql语句保存到切片中。
返回包含所有sql语句的切片。

三、代码实现

以下是使用go语言实现的读取并解析sql文件的函数：

package main
import (
	"bufio"
	"io"
	"os"
	"strings"
)
// readsqlfile 读取sql文件，并将文件中的sql语句分割成字符串切片返回。
func readsqlfile(filename string) ([]string, error) {
	var statements []string // 用于存储分割后的sql语句
	file, err := os.open(filename) // 打开文件
	if err != nil {
		return nil, err // 如果打开文件出错，返回错误
	}
	defer file.close() // 最后关闭文件
	reader := bufio.newreader(file) // 创建一个缓冲读取器
	var stmt strings.builder // 用于构建单个sql语句
	var inmultilinecomment bool // 标记是否处于多行注释中
	for {
		line, err := reader.readstring('\n') // 逐行读取
		if err != nil {
			if err == io.eof { // 如果读到文件末尾
				if stmt.len() > 0 { // 如果stmt中有内容，说明还有未结束的sql语句
					stmt.writestring(strings.trimspace(line)) // 去除末尾的空白字符
					statements = append(statements, stmt.string()) // 将构建好的sql语句添加到切片中
				}
				break // 结束循环
			}
			return nil, err // 如果读取过程中发生错误，返回错误
		}
		line = strings.trimspace(line) // 去除行首尾的空白字符
		// 处理多行注释
		if inmultilinecomment {
			if strings.contains(line, "*/") { // 检查注释是否结束
				line = strings.split(line, "*/")[1] // 获取注释结束后的内容
				inmultilinecomment = false // 更新状态
			} else {
				continue // 如果注释未结束，跳过当前行
			}
		}
		// 处理单行注释
		if strings.hasprefix(line, "/*") {
			commentendindex := strings.index(line, "*/") // 查找注释结束的位置
			if commentendindex == -1 { // 如果注释未结束
				inmultilinecomment = true // 更新状态
				continue
			} else {
				line = line[commentendindex+2:] // 获取注释结束后的内容
			}
		}
		// 跳过单行注释
		if strings.hasprefix(line, "--") {
			continue
		}
		stmt.writestring(line) // 将当前行添加到stmt中
		// 检查是否是sql语句的结束
		if strings.hassuffix(line, ";") {
			statements = append(statements, stmt.string()) // 将构建好的sql语句添加到切片中
			stmt.reset() // 重置stmt，准备构建下一个sql语句
		}
	}
	return statements, nil // 返回分割后的sql语句切片
}
func main() {
	// 示例用法
	statements, err := readsqlfile("example.sql") // 读取sql文件
	if err != nil {
		panic(err) // 如果发生错误，中断程序
	}
	for _, stmt := range statements { // 遍历并打印每个sql语句
		println(stmt)
	}
}

四、代码解析

打开sql文件：使用os.open函数打开文件，并使用defer关键字确保文件在函数结束时关闭。
逐行读取文件内容：使用bufio.newreader创建一个缓冲读取器，通过循环调用readstring函数逐行读取文件内容。
过滤掉注释和空行：通过判断行首是否包含/、/、–等注释标识，过滤掉注释和空行。
拼接sql语句：使用strings.builder类型拼接sql语句，以提高性能。
将拼接好的sql语句保存到切片中：当遇到分号（;）时，将拼接好的sql语句添加到切片中，并重置stmt变量。
返回包含所有sql语句的切片：当文件读取完毕时，返回包含所有sql语句的切片。