首页
/ 推荐开源项目:sql-formatter —— 精致的SQL格式化工具

推荐开源项目:sql-formatter —— 精致的SQL格式化工具

2024-06-08 07:24:34作者:何将鹤

在数据库开发和管理中,保持SQL代码的整洁与规范至关重要,它能提高团队协作效率,并使得代码易于理解和维护。今天,我们向您推荐一款纯Java实现的SQL格式化库——sql-formatter,它能帮您轻松地将凌乱的SQL语句转化为美观易读的代码块。

1、项目介绍

sql-formatter是基于Java标准库开发的轻量级开源项目,无需任何额外依赖。它受到ZeroTurnaround的知名SQL格式化器启发,提供了一种简单而高效的方式来整理SQL语句,使其符合编码规范。此外,它还提供了在线演示版,方便开发者直接试用(Demo)。

2、项目技术分析

该项目使用纯Java编写,没有引入外部库,保证了其小巧且易于集成。它支持多种SQL方言,包括但不限于Standard SQL、MySQL、PostgreSQL、Oracle PL/SQL等。通过Dialect类,您可以轻松切换不同的语法环境。

sql-formatter不仅提供基础的格式化功能,还允许自定义配置,如缩进风格、大小写转换、查询之间的行间距以及列的最大长度。此外,它还支持占位符替换,能够处理命名或索引型参数。

3、项目及技术应用场景

  • 开发工具:集成到IDEA、VSCode等开发环境中,实时美化SQL代码。
  • 数据库脚本整理:大量手写或复制的SQL脚本需要规范化处理时。
  • 代码审查:确保团队成员提交的SQL代码符合统一的格式规范。
  • 自动化测试:在自动化测试框架中,自动格式化生成的SQL语句。
  • 服务器端API:通过网络接口提供在线SQL格式化服务。

4、项目特点

  • 无依赖:仅使用Java标准库,便于集成。
  • 多语言支持:覆盖多种主流SQL方言,满足各种数据库系统的需求。
  • 高度可配置:提供FormatConfig构建器以定制您的格式化规则。
  • 动态扩展:允许自定义添加运算符,适应项目特有的语法。
  • 参数替换:支持通过列表或映射进行参数化的SQL格式化。

通过上述特性,sql-formatter成为了开发人员在处理SQL代码时的强大助手,无论是日常开发还是自动化任务,都能展现出高效的代码组织能力。

要开始使用这个项目,只需按照README中的指引添加对应的Maven或Gradle依赖,然后调用SqlFormatter提供的API即可。赶快将sql-formatter纳入您的开发工具箱,享受它带来的便利吧!

// Maven
<dependency>
  <groupId>com.github.vertical-blank</groupId>
  <artifactId>sql-formatter</artifactId>
  <version>2.0.5</version>
</dependency>

// Gradle
implementation 'com.github.vertical-blank:sql-formatter:2.0.5'

在代码中尝试一下:

SqlFormatter.format("SELECT * FROM table1");

简短的一行代码,即能将SQL世界变得更美好。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
118
1.88 K
kernelkernel
deepin linux kernel
C
22
6
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
341
1.24 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
191
271
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
912
546
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
377
388
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
143
188
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
68
58
harmony-utilsharmony-utils
harmony-utils 一款功能丰富且极易上手的HarmonyOS工具库,借助众多实用工具类,致力于助力开发者迅速构建鸿蒙应用。其封装的工具涵盖了APP、设备、屏幕、授权、通知、线程间通信、弹框、吐司、生物认证、用户首选项、拍照、相册、扫码、文件、日志,异常捕获、字符、字符串、数字、集合、日期、随机、base64、加密、解密、JSON等一系列的功能和操作,能够满足各种不同的开发需求。
ArkTS
81
2