Java代码之美,从遵循样式规范开始
01
为什么要代码样式规范
对于团队开发,不同的代码规范或不规范可能引起的问题包括但不限于:
1.代码可读性,代码是为了人阅读的,不是只为了机器执行;
2.代码format引发的大量的diff,干扰code review;
3.间接影响代码质量和团队协作效率。
在敏捷迭代的软件开发环境中,良好的代码规范不仅能够帮助团队成员快速理解彼此的代码,减少沟通成本,还能在代码维护和扩展时节省宝贵的时间。此外,一致的代码风格也是项目专业性的体现,能够给代码审查者和未来的维护者留下良好的第一印象。
02
探索Java代码规范
我们将深入探讨Java社区广泛认可的编码规范,包括但不限于Google Java Style和Oracle官方的编码指南。从命名约定、代码格式化、注释的使用,到错误处理和测试代码的编写,每一个细节都是构建高质量Java代码的关键。
a. 规范选择
上面列举了多项代码规范,在决定使用哪种规范之前,可以考虑三个方面:
- 明确目标:使用代码规范的目的是什么,只是为了项目内代码风格一致,还是为了和其他团队分享或者其他公司分享或者开源?
- 使用环境:开发阅读代码的环境是什么,GitHub、GitLab、公司内部的代码平台?
- 工具支持:code format工具支持情况,code sytle check工具支持情况,编译工具:maven、gradle,IDE:IntelliJ、Eclipse、VS Code;
综合上面的三个方面的考虑,优先选择Google Java Style。
b. 规范制定
Google Java Style部分代码样式团队难以接受,比如2空格缩进等,可以在原始Google Java Style基础上,适当定制化调整。
代码样式规范的使用分为两个方面:
- 代码格式化
- 代码样式校验
注意:code style 跟 check style 的「配置文件」必须对应,即按照code style format的代码check style不报错。
代码样式校验
代码格式化依赖于开发者手动进行格式化,为达到团队/项目代码样式规范的落地,需要有全面的自动化的代码检查。根据当前业界推荐,采用Checkstyle作为自动化代码样式校验工具。
需要对原始 Google Code Style 的google_checks进行定制,以适配上面intellij-java-jd-style.xml的定制。
- 修改google_checks中的内容:
除了上述的长度和缩进的代码样式校验,Checkstyle还可以配置其它代码校验,可根据团队接受情况予以配置。
03
最佳实践:如何将规范融入日常开发
a. IDEA配置Code Style
在 IntelliJ IDEA下,使用intellij-java-jd-style.xml进行代码格式化之前,需要先进行配置。
设置配置文件,路径:IntelliJ IDEA→Preference→Editor→Code Style,参考下图:
导入定制的Code Style文件:intellij-java-jd-style.xml
命名Scheme,如图中JD-Style,并启用该代码样式规范
b. IDEA使用Code Style
完成上述配置后,在Mac环境的IntelliJ IDEA中,可以对选中的代码格式化(快捷键:Option+Command+L)或者对选中的文件格式化(快捷键:Shift+Option+Command+L)
Check Style的配置和使用有两种主要方式:
1. 在开发环境IDE中,开发者配置插件后,可触发代码样式规范的检查,根据提示项进行代码修改;
2.在maven项目中,配置Check Style插件,可用命令行触发代码样式规范的检查,集成到CI (Continuous Integration)的自动化流水线中。
a. IDEA配置CheckStyle插件
在 IntelliJ IDEA下,安装Plugin,路径:IntelliJ IDEA→Preference→Plugins,参考下图:
下载配置文件checkstyle.xml,配置CheckStyle-IDEA插件,路径:IntelliJ IDEA→Preference→Tools→Checkstyle,增加自定义配置文件并命名,参考下图:
b. IDEA使用CheckStyle插件
安装配置CheckStyle插件后,工具窗口增加了CheckStyle Tab,在CheckStyle窗口进行check,可以选择:
- Check Current File
- Check Module
- Check Project
c. maven配置CheckStyle插件
参考Checkstyle maven插件的官方配置案例:多模块项目配置,通常我们在项目中新建build-tools模块,将checkstyle.xml等配置文件放在这个模块的resources目录下。
build-tools模块的pom.xml使用IDEA自动生成的配置文件,类似:
配置文件checkstyle.xml、checkstyle-suppressions.xml可以从coding中下载
父项目的pom.xml中,增加如下配置:
maven-checkstyle-plugin的配置<configuration>参数具体可参见checkstyle:check的参数说明。
这里对几项配置进行说明:
- plugins>plugin>executions>execution
- id可以自行决定,这里选择\”checkstyle\”;
- phase是绑定到maven lifecycle的哪个执行阶段,这里绑定到\”validate\”上,即执行maven validate的时候会执行该plugin任务;选择validate阶段可以保障checkstyle:check在代码编译之前执行,如果checkstyle检查出违反样式规范的问题,在代码编译之前就会报告出来;
- goals>goal是只绑定执行plugin的哪个任务,这里绑定的是\”check\”;
- plugins>plugin>configuration>failOnViolation
- 检查到违反样式规范的问题,打印出来,打印的问题级别根据checkstyle.xml中配置的severity确定;
- 将severity级别配置为error,并将failOnViolation设为true,检查到违反样式规范的问题时,会停止maven命令继续执行;
注意:failOnViolation与failOnError配置项的区别,failOnError在检查到问题时立即停止执行,failOnViolation在检查到问题时输出检查日志再停止执行。
按照上述配置,可达到在mvn编译代码前强制检查代码样式规范,发现违反规范的问题,不会继续java的编译、打包。
运行mvn package即可正常打包。
也可以单独执行命令:
注意:为了实现自动化代码样式规范检查,可以为项目配置行云流水线任务,设置代码评审的自动化检查:指定流水线作为卡点,指定为卡点的流水线需运行成功后MR才允许合并。
04
结语:代码规范-团队协作的桥梁
最后,我们总结下Java样式规范对于团队协作的重要性,鼓励每位开发者将这些规范内化为自己的编码习惯。因为代码规范不仅是个人技艺的体现,更是团队协作和项目成功的基石。
通过阅读本文,你将不仅了解到Java样式规范的重要性,还将掌握如何将这些规范应用到实际开发中,让你的代码变得更加优雅和强大。让我们一起追求编码的艺术,用规范的代码点亮编程的世界。
选Python还是选Java?2020年,顶尖程序员最应该掌握的7种编程语言
选自Medium
作者:Claire D
机器之心编译
参与:李诗萌、蛋酱
哪种编程语言最好?这个问题可能永远不会有答案。萝卜白菜,各有所爱,AI 工程师和科学家可以根据项目需要,从众多编程语言中选择最适合自己的。
有人曾经将编程比作做菜,那编程语言就是首先要准备的食材或厨具。
C:一把菜刀一口炒锅,一个很好用的灶,隔壁有个菜市场。Java:碎菜器,切菜机,绞肉机,和面机,烤箱,微波炉……Python:大超市的速冻柜台,要成品有成品,要半成品有半成品,什么都有。它能让你快速获得一桌还能吃的饭,但是深究口味火候什么的不那么容易。C++:一套顶级厨具,光刀就十几把,切肉的切片的雕花的;锅有爆炒的闷烧的平底煎肉的煎蛋的炖汤的……有人试图用二十一天掌握这套工具的用法,结果往往是玩刀伤了自己,或者是炸了厨房。
选自知乎用户:https://www.zhihu.com/question/284549387/answer/451018336
尽管在刚开始开发 AI 时,有很多编程语言都可以满足你的需求,但没有一种编程语言是可以一站式解决 AI 编程的问题,因为在每一个项目中,不同的目标需要特定的方法。和做菜时的精挑细选一样,在成为一个「高手」的过程中,我们要学会的是找到最适合自己的编程语言。Python
Python 是可读的最强大的语言。—Pau Dubois
Python 编程。图源:Unsplash。Python 开发于 1991 年,一项民意调查表明,在开发 AI 时,超过 57% 的开发者将 Python 作为首选编程语言,而不是 C++。因为易于学习,Python 让程序员和数据科学家可以更轻松地进入开发 AI 的世界。
Python 是一个程序员需要多少自由度的「实验」。太自由,没人可以读懂别人的代码;太不自由,就会没那么强的表现力。—Guido van Rossum
使用 Python,你不仅可以获得优秀的社区支持和广泛的库集,还能享受到其灵活性。你从 Python 中得到的最大的好处可能是平立性和针对深度学习和机器学习的广泛框架。
用 Python 编码的乐趣在于可以看到短小精悍、可读性高的类,这些类可以用少量清晰的代码表达大量行为(而不是用大量代码烦死读者)。——Guido van Rossum
Python 代码片段示例:
Python 代码段落示例。常用的库
- TensorFlow——用于机器学习工作负载和用数据集处理;
- scikit-learn——训练机器学习模型;
- PyTorch——计算机视觉和自然语言处理;
- Keras——高度复杂性的数学计算和操作的代码接口;
- SparkMLib——类似 Apache Spark 的机器学习库,通过算法和实用程序等工具,让每一个人都能轻松地进行机器学习;
- MXNet——Apache 的另一个库,可以简化深度学习流程;
- Theano——定义、优化和评价数学表达式的库;
- Pybrain——用于强大的机器学习算法。
另外,根据 GitHub 库的贡献度,Python 已经超越了 Java,成为世界第二受欢迎的语言。Stack Overflow 将 Python 称为「成长最快」的主流编程语言。
Python 入门课程
- 《三门免费的 Python 入门课程:2020 版》
课程链接:https://hackernoon.com/3-free-python-courses-for-beginners-2020-edition-j7c23y3u
- 《完整 Python 训练营:用 Python 3 从小白到大师》
课程链接:https://www.udemy.com/course/complete-python-bootcamp/?LSNPUBID=JVFxdTr9V80&ranEAID=JVFxdTr9V80&ranMID=39197&ranSiteID=JVFxdTr9V80-lB6TwxSdouentAk36.qjmwJava
编写一次,随时运行。
Java 被公认为世界上最好的编程语言之一,它在过去 20 年间的使用情况就是最好的证明。凭借其用户友好度、灵活的特性以及平立性,Java 以各种方式参与到了 AI 的开发中,比如:
- TensorFlow——TensorFlow 支持的编程语言中也列出了带有 API 的 Java。虽然不像其他完全支持的语言那样功能丰富,但确实支持 Java,并且在迅速地改进。
- Deep Java Library(深度 Java 库)——亚马逊开发的、用 Java 来创建并部署深度学习能力的库。
- Kubeflow——Kubeflow 使在 Kubernetes 上部署和管理机器学习堆栈更容易,还提供了现成的 ML 解决方案。
- OpenNLP——Apache 的 OpenNLP 是用于自然语言处理的机器学习工具。
- Java Machine Learning Library(Java 机器学习库)——Java-ML 为开发者提供了多种机器学习算法。
- Neuroph——Neuroph 借助 Neuroph GUI,利用 Java 开源框架设计了神经网络。
如果 Java 可以垃圾回收,大多数程序都会在执行时删除自己。——Robert Sewell
Java 代码片段示例:
Java 代码段示例。Java 入门课程
- 《五大在线 Java 编程入门课程——最好的》
课程链接:https://javarevisited.blogspot.com/2018/05/top-5-java-courses-for-beginners-to-learn-online.htmlRRoss Ihaka 和 Robert Gentleman 在 1995 年发布了第一版 R 语言。现在由 R 开发核心队伍维护,R 是 S 编程语言的实现,用于统计软件的开发和数据的分析。R 的基础特征是善于处理大量数据,相比 Python 中不够完善的 NumPy 包,R 是更好的选择;你可以用 R 处理各种不同的编程范式,比如函数式编程、矢量计算和面向对象编程等。R 适用的 AI 编程包:
- Gmodels——提供了一系列拟合模型用的工具;
- Tm——文本挖掘应用的框架;
- RODBC——R 的 ODBC 接口;
- OneR——用来实现单规则机器学习分类算法,适用于机器学习模型。
在数据挖掘者和统计学家中,广泛使用的 R 的功能有:
- 多种用于扩展功能的库和包;
- 活跃的支持社区;
- 能和 C、C++ 和 Fortran 协同工作;
- 多个有助于扩展功能的包;
- 支持生成高质量的图形。
Prolog逻辑编程(Logic Programming)的简称。Prolog 最早出现在 1972 年,适用于开发人工智能,尤其是自然语言处理。Prolog 最适合创建聊天机器人,ELIZA 是有史以来第一个用 Prolog 创建的聊天机器人。
第一个成功的聊天机器人。为了理解 Prolog,你必须熟悉一些指导 Prolog 工作的基本术语:
- 事实(Fact)定义了正确的陈述;
- 规则(Rule)定义了有附加条件的陈述;
- 目标(Goal)根据知识库定义了提交陈述的位置;
- 查询(Query)定义了如何使你的陈述正确,以及对事实和规则的最终分析。
Prolog 提供了两种实现 AI 的方法,这两种方法已经实现很久了,并且在数据科学家和研究人员中广为人知:
- 符号方法包括基于规则的专家系统、定理证明和基于约束的方法;
- 统计方法包括神经网络、数据挖掘、机器学习以及其他方法。
Lisp
用 Lisp 编码创建有 n 个输入 m 个单元的一层感知机。列表处理(List Processing)的简称。这是继 Fortran 后第二古老的编程语言。也被称作 AI 的奠基语言之一,由 John McCarthy 与 1958 年创建。
Lisp 是用来实现不可能的语言。——Kent Pitman
Lisp 是可以编程的实用数学符号,很快就成为了开发人员首选的 AI 编程语言。Lisp 因为其特有的功能,成为机器学习 AI 项目的最佳选择之一:
- 快速创建原型;
- 创建动态对象;
- 垃圾回收;
- 灵活性。
随着其他竞争的编程语言的重大改进,其他语言集成了 Lisp 特有的一些功能。涉及到 Lisp 的著名项目有 Reddit 和 HackerNews。
说到 Lisp,这是世界上最美的语言——至少在 Haskell 出现之前是这样。——Larry Wall
HaskellHaskell 创建于 1990 年,以著名数学家 Haskell Brooks Curry 的名字命名。Haskell 是纯粹的函数式和静态类型的编程语言,与惰性计算和短代码配合使用。Haskell 是一种非常安全的编程语言,因为和其他编程语言相比,Haskell 很少出现错误,所以在处理错误方面提供了更大的灵活性。即便发生了错误,也可以在编译(而非运行)时捕获大多数非语法错误。Haskell 提供的功能包括:
- 强大的抽象能力;
- 内置的内存管理;
- 代码的可重用性;
- 易于理解。
SQL、Lisp 和 Haskell 是我所见过的唯一可以把时间花在思考而不是打字上的编程语言。——Philip GreenspunHaskell 的功能有助于提高程序员的生产率。Haskell 与其他编程语言非常相似,但只有一小部分开发人员使用。撇开挑战不谈,随着开发者社区使用率的增加,可以证明 Haskell 和其他用于 AI 的竞争语言一样出色。
JuliaJulia 是一种高性能的通用动态编程语言,可以创建几乎任何应用,但最适合进行数值分析和计算科学。和 Julia 一起使用的工具还包括:
- 像 Vim 和 Emacs 这样流行的编辑器;
- 像 Juno 和 Visual Studio 这样的 IDE。
Julia 源代码组织。Julia 中有一些功能使其成为 AI 编程、机器学习、统计和数据建模的重要选择,这些功能有:
- 动态类型系统;
- 内置的包管理器;
- 能够进行并行和分布式计算;
- 宏和元编程能力;
- 支持多分派;
- 直接支持 C 函数。
Julia 是为了消除其他编程语言的弱点而构建的,和其他工具(如 TensorFlow.jl、MLBase.jl 和 MXNet.jl)集成后还可以用于机器学习,利用 Julia 的可伸缩性还可以做更多事。
谷歌趋势——Julia 的使用趋势。总结AI 工程师和科学家可以根据项目的需求,从多种编程语言中进行选择。每一种 AI 编程语言都有优缺点。随着这些语言的不断改进,AI 开发很快就可以有更舒适的体验,这样就会有更多人加入这一创新浪潮。出色的社区支持使新人们可以更好地工作,社区对包和扩展的贡献让每个人的工作都变得更加轻松。参考链接:https://towardsdatascience.com/top-programming-languages-for-ai-engineers-in-2020-33a9f16a80b0
本文作者及来源:Renderbus瑞云渲染农场https://www.renderbus.com
文章为作者独立观点不代本网立场,未经允许不得转载。