0

0

Go 多行字符串字面量的缩进规范与最佳实践

花韻仙語

花韻仙語

发布时间:2026-01-13 12:26:12

|

787人浏览过

|

来源于php中文网

原创

Go 多行字符串字面量的缩进规范与最佳实践

go 原生不支持自动去除多行原始字符串首行缩进,直接缩进会导致换行后内容含多余空格;推荐使用 dedent 工具包或手动调整结构,兼顾可读性、可维护性与 sql 语义正确性。

在 Go 中编写多行 SQL 或其他结构化文本时,原始字符串字面量(`...`)虽避免了转义问题,但其缩进处理易引发实际困扰:若按代码缩进对齐字符串内容(如首行顶格、后续行用空格对齐),会导致 SQL 中混入不可见的前导空格,影响查询逻辑或可读性;若将字符串整体左移至行首(即换行后立即开始内容),又会破坏代码整体缩进风格,降低可维护性。

推荐方案一:使用 github.com/lithammer/dedent(最实用)
该库行为类似 Python 的 textwrap.dedent(),自动计算并移除每行共有的最小缩进量,保留相对缩进关系:

import "github.com/lithammer/dedent"

// ✅ 清晰、对齐、无冗余空格
if select == nil {
    select, err = db.Prepare(dedent.Dedent(`
        select name
        from table
        where id = $1
    `))
    if err != nil {
        return nil, err
    }
}

注意:dedent.Dedent 会忽略首行(空行或仅含空白符的行)和末行的缩进,因此上面示例中三重反引号之间的首尾换行及缩进均被安全处理,最终生成的字符串为:

WPS灵犀
WPS灵犀

WPS灵犀是WPS推出的一款AI智能办公和学习助手

下载
select name
from table
where id = $1

推荐方案二:手动拼接(零依赖,适合简单场景)
对短 SQL 可用 + 拼接 + 单行字符串,保持缩进一致性且无空格风险:

if select == nil {
    query := "select name " +
             "from table " +
             "where id = $1"
    select, err = db.Prepare(query)
    // ...
}

不推荐做法

  • ❌ 直接缩进原始字符串(如问题中第一种写法):编辑器 tab 宽度差异可能导致 SQL 出现意外空格,且难以肉眼校验;
  • ❌ 强制顶格书写(第二种写法):破坏代码块缩进层级,损害整体代码风格统一性。

总结:对于含多行结构化文本(尤其是 SQL、JSON 模板等)的 Go 项目,应优先引入 dedent 包——它轻量(仅一个函数)、稳定、语义明确,并已成为社区广泛采纳的惯用模式。同时建议在团队规范中明确此约定,避免因格式分歧引入隐蔽错误。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

1090

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

339

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

380

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

1988

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

379

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

1540

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

585

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

438

2024.04.29

AI安装教程大全
AI安装教程大全

2026最全AI工具安装教程专题:包含各版本AI绘图、AI视频、智能办公软件的本地化部署手册。全篇零基础友好,附带最新模型下载地址、一键安装脚本及常见报错修复方案。每日更新,收藏这一篇就够了,让AI安装不再报错!

0

2026.03.04

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.7万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号