Code Style 那些事

代码风格虽然不像某端技术圈那么容易炸锅, 也不像编程语言或者编辑器那样容易站队, 但人多了总要有一个统一的风格, 提高工作效率. 最近逐渐统一团队的代码风格, 记录一下思考过程.

0x00 确定代码风格的原则

如何确定一个统一的代码风格? 空格是用 TAB? 每行最多几个字符? 某某地方应该空出几行.... 如果开会来讨论这些问题, 估计可以吵一天, 然后把所有的意见写一本书.

但要推广下来, 确是要有如下工具支撑才可以高效率的推广:

• 有命令行工具做代码格式检查和代码格式化, 不能全部靠人力 review 甚至手动格式化代码
• 工具要方便整合到 CI 中, 方便自动化.

有了这两个原则, 再争吵, 谁想推广自己的方案, 一定要搞定上述两条才算合格, 否则就是"嘴炮", 不解决问题.

基于上面两个原则, 翻了一下现有的方案, 发现 Google 简直就是一家良心公司啊....基本上照着抄就行了.....

0x01 Go

Go 语言根本都不用费事, gofmt 一下解决, 再在本地代码中添加如下 pre-commit 的 git hook, 收工了. 多说一句, 我本人还是非常赞赏 Go 这种做法的: 就一种格式, 少 BB.

#!/bin/sh
gofiles=$(git diff --cached --name-only --diff-filter=ACM | grep '\.go$')
[ -z "$gofiles" ] && exit 0

unformatted=$(gofmt -l $gofiles)
[ -z "$unformatted" ] && exit 0

# Some files are not gofmt'd. Print message and fail.

echo >&2 "Go files must be formatted with gofmt. Please run:"
for fn in $unformatted; do
    echo >&2 "  gofmt -w $PWD/$fn"
done

exit 1

0x02 Python

针对 Python 语言 Google 有 yapf: A formatter for Python files. 不解的是, yapf 居然支持一些所谓的"定制化", 这真的有必要吗?

我们的选择很简单也很专制, 直接用 README 中的 example 即可:

[style]
based_on_style = pep8
spaces_before_comment = 4
split_before_logical_operator = true

0x03 Java

Google 官方早就有自己的 Google Java Style, 并且为了贯彻这个, 作了一个项目 google-java-format, 不仅提供了命令行工具, 甚至还有 IDEA 和 eclipse 两种 IDE 的插件.

不过 google-java-format 命令行工具不支持 --diff 选项, 也就是说将代码格式化后与原有的代码进行 diff, 如果代码格式不符合要求, diff 的内容不为空, 这是方便接入 CI 中自动代码检查的关键. 因此需要手动实现 diff 功能, 示例代码如下:

#!/bin/bash
#

set -e
current_dir=`cd $(dirname $0);pwd`
cd $current_dir/../
check_cmd="java -jar sbin/google-java-format-1.3-all-deps.jar "

function check_code_style() {
    for java_file in `find src -type f -name '*.java'`
    do
        tmp_file="/tmp/$RANDOM.java"
        $check_cmd $java_file >$tmp_file
        local diff_code=`diff $java_file $tmp_file`
        rm $tmp_file
        if [ -n "$diff_code" ]
        then
            echo
            echo "code style not match, file: $java_file"
            echo
            printf "use \n\t$check_cmd --replace $java_file \n\nto format the code\n"
            echo
            exit 2
        fi
    done
    echo
    echo "code style check pass"
    echo
}

time check_code_style

0x04 SQL

我猜 Google 不怎么写 SQL, 因此没有一个官方的 SQL-format 项目出来. 只有使用 sqlparse 自己写一个 formatter了.

-- EOF --