Apache ShardingSphere 代码格式化实战 —— Spotless
龙台,Apache ShardingSphere Contributor,GitHub 2.2K star hippo4j 作者,Github ID:longtai-cn。
为什么要代码格式化?代码格式化的意义是让代码更加 易读易懂易修改。
ShardingSphere 作为 Apache 顶级开源项目,截止当前已有 380+ 贡献者。因为大部分开发人员的代码风格不一致,在 Github 多人协作的模式下,不易保障项目整体代码格式。
基于以上诉求,ShardingSphere 采用了 Spotless 充当代码格式统一的角色。
什么是 Spotless
Spotless 是支持多种语言的代码格式化工具,支持 Maven 和 Gradle 以 Plugin 的形式构建。
Spotless 对开发者来说,有 2 种使用方式:检查代码是否存在格式问题,以及格式化代码。
ShardingSphere 采用 Maven 构建项目,以下若无特殊声明,Spotless 使用 Maven 做演示。
如何使用
下述代码是 Spotless 官方示例。
user@machine repo % mvn spotless:check
[ERROR] > The following files had format violations:
[ERROR] src\main\java\com\diffplug\gradle\spotless\FormatExtension.java
[ERROR] -\t\t····if·(targets.length·==·0)·{
[ERROR] +\t\tif·(targets.length·==·0)·{
[ERROR] Run 'mvn spotless:apply' to fix these violations.
user@machine repo % mvn spotless:apply
[INFO] BUILD SUCCESS
user@machine repo % mvn spotless:check
[INFO] BUILD SUCCESS
通过 mvn spotless:check
检查项目代码时发现错误,接着使用 mvn spotless:apply
进行代码格式化;再次检查时,格式化错误消失。
1. 项目实战
ShardingSphere 使用 Spotless 实现了添加 Java 文件 licenseHeader 和 Java 代码格式化。
Spotless 有多种 Java 代码格式化方式,例如:googleJavaFormat、eclipse、prettier 等。基于定制化的考虑,最终采用 eclipse 进行 Java 代码格式化。
1)根据项目需求添加 licenseHeader
/** Licensed to the Apache Software Foundation (ASF) under one or more* contributor license agreements. See the NOTICE file distributed with* this work for additional information regarding copyright ownership.* The ASF licenses this file to You under the Apache License, Version 2.0* (the "License"); you may not use this file except in compliance with* the License. You may obtain a copy of the License at** http://www.apache.org/licenses/LICENSE-2.0** Unless required by applicable law or agreed to in writing, software* distributed under the License is distributed on an "AS IS" BASIS,* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.* See the License for the specific language governing permissions and* limitations under the License.*/
注意,licenseHeader 最后要留有一行空格。不然 licenseHeader 和 package 之间将没有空隙。
2)添加 shardingsphere_eclipse_formatter.xml
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!--
/*** Licensed to the Apache Software Foundation (ASF) under one* or more contributor license agreements. See the NOTICE file* distributed with this work for additional information* regarding copyright ownership. The ASF licenses this file* to you under the Apache License, Version 2.0 (the* "License"); you may not use this file except in compliance* with the License. You may obtain a copy of the License at** http://www.apache.org/licenses/LICENSE-2.0** Unless required by applicable law or agreed to in writing, software* distributed under the License is distributed on an "AS IS" BASIS,* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.* See the License for the specific language governing permissions and* limitations under the License.*/
-->
<profiles version="13"><profile kind="CodeFormatterProfile" name="'ShardingSphere Apache Current'" version="13"><setting id="org.eclipse.jdt.core.compiler.source" value="1.8"/><setting id="org.eclipse.jdt.core.compiler.compliance" value="1.8"/><setting id="org.eclipse.jdt.core.compiler.codegen.targetPlatform" value="1.8"/><setting id="org.eclipse.jdt.core.formatter.indent_empty_lines" value="true"/><setting id="org.eclipse.jdt.core.formatter.tabulation.size" value="4"/><setting id="org.eclipse.jdt.core.formatter.lineSplit" value="200"/><setting id="org.eclipse.jdt.core.formatter.comment.line_length" value="200"/><setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="space"/><setting id="org.eclipse.jdt.core.formatter.indentation.size" value="1"/><setting id="org.eclipse.jdt.core.formatter.comment.format_javadoc_comments" value="false"/><setting id="org.eclipse.jdt.core.formatter.join_wrapped_lines" value="false"/><setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_conditional" value="insert"/><setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_default" value="do not insert"/><setting id="org.eclipse.jdt.core.formatter.alignment_for_enum_constants" value="16"/><setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_labeled_statement" value="do not insert"/><setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_case" value="do not insert"/><setting id="org.eclipse.jdt.core.formatter.alignment_for_conditional_expression" value="80"/><setting id="org.eclipse.jdt.core.formatter.alignment_for_assignment" value="16"/><setting id="org.eclipse.jdt.core.formatter.blank_lines_after_package" value="1"/><setting id="org.eclipse.jdt.core.formatter.continuation_indentation_for_array_initializer" value="2"/><setting id="org.eclipse.jdt.core.formatter.alignment_for_resources_in_try" value="160"/><setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_method_declaration" value="10"/><setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_method_declaration" value="106"/><setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_constructor_declaration" value="106"/><setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_constructor_declaration" value="106"/><setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call.count_dependent" value="16|5|80"/></profile>
</profiles>
ShardingSphere 最新规则查看 shardingsphere_eclipse_formatter.xml,另提供一份 eclipse-java-google-style.xml 供参考
shardingsphere_eclipse_formatter.xml 的内容是根据 ShardingSphere 代码规范定制开发的,可灵活变动。
3)添加 Maven plugin
<plugin><groupId>com.diffplug.spotless</groupId><artifactId>spotless-maven-plugin</artifactId><version>2.22.1</version><configuration><java><eclipse><file>${maven.multiModuleProjectDirectory}/src/resources/shardingsphere_eclipse_formatter.xml</file></eclipse><licenseHeader><file>${maven.multiModuleProjectDirectory}/src/resources/license-header</file></licenseHeader></java></configuration>
</plugin>
Spotless 支持格式化指定目录,以及排除指定目录的功能,详情参考 plugin-maven#java。如无指定,执行 check 或 apply 时,默认项目全量代码。
4)执行代码格式化
执行完上述三个步骤,就可以在项目中执行命令,检查 Java 代码是否符合规范,以及代码格式化功能。
user@machine repo % mvn spotless:apply
[INFO] BUILD SUCCESS
user@machine repo % mvn spotless:check
[INFO] BUILD SUCCESS
2. 绑定 Maven 生命周期
在 ShardingSphere 实际应用中,选择将 Spotless apply 绑定到 compile 阶段,这样本地执行 mvn install 时就能自动格式化。
<plugin><groupId>com.diffplug.spotless</groupId><artifactId>spotless-maven-plugin</artifactId><version>2.22.1</version><configuration><java><eclipse><file>${maven.multiModuleProjectDirectory}/src/resources/shardingsphere_eclipse_formatter.xml</file></eclipse><licenseHeader><file>${maven.multiModuleProjectDirectory}/src/resources/license-header</file></licenseHeader></java></configuration><executions><execution><goals><goal>apply</goal></goals><phase>compile</phase></execution></executions>
</plugin>
3. IDEA 格式化
开发者如果在写代码过程中,想检查单个文件是否符合规范,执行 mvn spotless:check
或 mvn spotless:apply
显得有些笨重,因为格式化范围默认是整个项目。
我们可以使用 shardingsphere_eclipse_formatter.xml 替换 IntelliJ IDEA 原有格式化功能,这样在写代码过程中可以随时格式化,极大提升了开发效率。
IDEA 版本 2019.3.4。
1)安装插件 Eclipse Code Formatter
2)选择 shardingsphere_eclipse_formatter.xml 为默认格式化模板
使用 IDEA 代码格式化快捷键,就可以完成 Spotless 代码格式化。
常见问题
1. Spotless 与 Checkstyle 冲突
Checkstyle 是一种用于检查 Java 源代码是否符合代码标准或一组验证规则(最佳实践)的工具。
极端场景下,Spotless 格式化代码后,通过 Checkstyle 检查代码会不通过。
根本原因在于两者设定的检查配置和格式化配置冲突。举个例子,Spotless 格式化后换行缩进了 16 个空格,而 Checkstyle 的换行检查是 12 个空格。
private static Collection<PreciseHintShadowValue<Comparable<?>>> createNoteShadowValues(final ShadowDetermineCondition shadowDetermineCondition) {// Checkstyle 可以通过的格式return shadowDetermineCondition.getSqlComments().stream().<PreciseHintShadowValue<Comparable<?>>>map(each -> new PreciseHintShadowValue<>(tableName, shadowOperationType, each)).collect(Collectors.toList());// Spotless 格式化后return shadowDetermineCondition.getSqlComments().stream().<PreciseHintShadowValue<Comparable<?>>>map(each -> new PreciseHintShadowValue<>(tableName, shadowOperationType, each)).collect(Collectors.toList());
}
这种情况,需要开发者衡量如何取舍。解决方案有两种:修改 Spotless 的格式化规则,或修改 Checkstyle 的检查规则。
2. CRLF 与 LF 格式化冲突
参考 CRLF will be converted to LF when submitting documents · Issue #1171 · diffplug/spotless · GitHub
文末总结
文章介绍了 Apache ShardingSphere 使用 Spotless 完成历史代码格式化,以及后续代码格式的统一,对项目代码的整洁起到了很大帮助。
当然,Spotless 的功能不止 Java 代码的格式化,包括不限于 Pom 和 Markdown 等文件类型的格式化,后续这些都会在 ShardingSphere 得以应用。
欢迎点击链接,了解更多内容:
Apache ShardingSphere 官网:Apache ShardingSphere
Apache ShardingSphere GitHub 地址:GitHub - apache/shardingsphere: Ecosystem to transform any database into a distributed database system, and enhance it with sharding, elastic scaling, encryption features & more
SphereEx 官网:https://www.sphere-ex.com
欢迎添加社区经理微信(ss_assistant_1)加入交流群,与众多 ShardingSphere 爱好者一同交流。
Apache ShardingSphere 代码格式化实战 —— Spotless相关推荐
- 分布式数据库中间件Apache ShardingSphere京东落地实战
本文根据dbaplus社群第183期线上分享整理而成. 面对互联网大数据如火如荼发展.云服务需求的急剧增加,对企业极其重要的数据要如何面对这些新的变革? 作为Apache基金会的分布式数据库中间件项目 ...
- 【安全风险通告】Apache ShardingSphere远程代码执行漏洞安全风险通告
近日,奇安信云影实验室安全研究员maoge发现Apache ShardingSphere存在远程代码执行漏洞,目前官方已为该漏洞分配CVE编号:CVE-2020-1947.截至今日,该漏洞已修复.鉴于 ...
- Apache ShardingSphere 在京东白条场景的落地之旅
京东白条使用 Apache ShardingSphere 解决了千亿数据存储和扩容的问题,为大促活动奠定了基础. 2014 年初,"京东白条"作为业内互联网信用支付产品,数据量爆发 ...
- Apache ShardingSphere 元数据能力增强解读与实战
元数据介绍 Apache ShardingSphere 的元数据主要包括规则.数据源.表结构等信息.规则信息包含分片.加密.读写分离.事务.高可用等.数据源信息存储的是需要通过 ShardingSph ...
- 重磅!分布式数据库解决方案Apache ShardingSphere毕业成为顶级项目
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章 全球最大的开源软件基金会 Apache 软件基金会(以下简称 Ap ...
- 分布式数据库解决方案Apache ShardingSphere毕业成为顶级项目
点击上方蓝色"程序猿DD",选择"设为星标" 回复"资源"获取独家整理的学习资料! 来源 | 公众号「ShardingSphere官微」 全 ...
- 深度剖析Apache Shardingsphere对分布式事务的支持
Apache ShardingSphere 是一套开源的分布式数据库中间件解决方案组成的生态圈,它由 JDBC.Proxy 和 Sidecar(规划中)这 3 款相互独立,却又能够混合部署配合使用的产 ...
- Apache ShardingSphere 一文读懂
一.Apache ShardingSphere的概述 1.概述 官网:http://shardingsphere.apache.org/index_zh.html 下载地址:https://shard ...
- Apache ShardingSphere 企业行|走进中商惠民
为进一步了解各家厂商的应用场景与深层次需求,提升企业研发团队在使用 Apache ShardingSphere 的效率,Apache ShardingSphere 社区开启了[走进企业]系列活动. 近 ...
最新文章
- 架构设计之分布式文件系统
- 管理神话2:专家只有权这样做
- SQL学习(一)之简介
- flask 学习笔记 mvc ,sqlalchemy(insert,update)
- 高可用Redis服务架构分析与搭建
- Django echarts初试随笔
- Teams 可被滥用于安装恶意软件,微软或不打算修复
- 如何配置cmd操作XAMPP中的MYSQL的运行环境?
- 解决三星PM981硬盘无法正常安装黑苹果的问题(第一版)
- 什么是区块链? 区块链的入门教程~
- min-height和height的区别
- 每天接触互联网 了解互联网是什么
- 实验二猜字迷游戏程序开发
- 小数取整 四舍五入
- TPS和事务响应时间的关系、计算公式(转载)
- “华夏”二字之由来——我们为何称为“华夏”
- 富士x-e4参数 怎么样?测评值得买吗?
- 三分钟带你了解物联网的发展史
- Python中比较好用的PDF模块——发票金额提取
- 图书馆数据库系统的模拟练习
热门文章
- An Introduction to Interactive Programming in Python 最后的作业 -- 太空战机
- 大家谈中国:面对“双11网购第一脚”,阿里们不必窃喜
- Generalist: Decoupling Natural and Robust Generalization
- 系统性详解Redis操作Hash类型数据(带源码分析及测试结果)
- 【30篇突击 android】源码统计六
- 乐视云视频 接口开发 结合百度编辑器
- android中Connection.hangup()和Call.hangup()
- jssdk更新日志_微信jssdk录音功能开发记录
- python实现6的阶乘_python设计一个阶乘函数,并使用该函数求出6的阶乘。(怎么用python求阶乘的和教程)...
- 暮光之城中的对白(很美的英语)