插件推荐:如何将Java编码规范落地实际开发中

简介: 阿里近万名Java技术开发者通过不断总结与提炼,并经历了多次大规模一线实战检验及完善,出版了众所周知的《阿里巴巴Java开发手册》,但对于很多人而言,手册始终无法直接应用在日常的开发工作中,如果有相应的IDE插件进行支持,那简直完美。因此,Cloud Toolkit应运而生。

一个软件需要花费80%的生命周期成本去维护。  
几乎没有任何软件的整个生命周期仅由其原作者来维护。
编码规范改善软件的可读性,让工程师更快更彻底地理解新的代码。
如果你将源代码转变为一个产品,那么您需要确保它和你创建的其它产品一样是干净且包装良好的。

借用《Java编程语言代码规范》一段开场白,也许就解释了我们为什么需要编码规范。

无规矩不成方圆,无规范不能协作。阿里近万名Java技术开发者通过不断总结与提炼,并经历了多次大规模一线实战检验及完善,出版了众所周知的《阿里巴巴Java开发手册》,希望使更多的开发者团队在Java开发上更高效、容错、有协作性,提高代码质量并降低维护成本,而手册也尽可能涵盖开发常见环节,包括编程规约、单元测试规约、异常日志规约、MySQL规约、工程规约、安全规约等。

但对于很多人而言,手册始终无法直接应用在日常的开发工作中,如果有相应的IDE插件进行支持,那简直完美。因此,Cloud Toolkit应运而生。

Cloud Toolkit 集成了 Java 代码检查功能。该功能基于《阿里巴巴 Java 开发手册》中的代码规约,执行 Java 代码的静态检查,帮助您在编译前快速发现代码异常,并提供修改建议。

前提条件

已安装 2019.11.1 或更高版本的 Cloud Toolkit 插件。安装方法请参见
[• 在Eclipse中安装和配置Cloud Toolkit
](https://help.aliyun.com/document_detail/29970.html#task-1942357)
[• 在IntelliJ IDEA中安装和配置Cloud Toolkit
](https://help.aliyun.com/document_detail/98762.html#concept-29968-zh)

执行代码检查

1.在 IDE 的 Project 面板上左键单击要检查的工程文件,在弹出的菜单栏中选择 Alibaba Cloud > Coding Guidelines Check。p70195.png

如果您不想检查整个工程,也可以在工程的文件目录中选中想要检查的目录,在右侧代码编辑区域的空白处单击鼠标左键,选择 Alibaba Cloud > Coding Guidelines Check,进行检查。

2.在工程的文件目录区域下方会出现 Inspection Results 面板,可在面板下方看到代码检查进度。
Cloud Toolkit 默认将检查出的错误按照严重程度从高到低分为 Blocker、Critical、Major。Blocker 程度的错误可能会影响代码的成功编译。p70203.png

3.在 Inspection Results 面板的左侧区域显示错误信息目录。p70223.png
单击信息则右侧区域会显示错误代码,部分错误会提供快速修正建议,如下图中的标记 1 所示。Inspection Results 面板各区域功能说明如下。
• 上图标记 2:错误信息目录的最下级节点的行末显示错误代码所在行数 line XX。双击该级节点,则位于Inspection Results 面板上方的代码编辑区会定位到错误代码并高亮显示。
• 上图标记 3 区域内,从左至右,从上至下的按钮功能如下。
• Rerun Inspection:重新执行代码检查
• Group by Severity:按照错误严重程度分组错误信息
• Expand All:将错误信息目录展开至最下级
• Group by Directory:按照目录分组错误信息
• Collapse All:将错误信息目录收起至最上级
• Filter Resolved Items:过滤掉以及修改完成的错误
• Go Prev Problem:在错误目录区域移动至上一条错误
• Autocsroll to Source:打开此功能,在错误目录区域单击错误信息时,代码编辑区自动跳转到错误代码
• Go Next Problem:在错误目录区域移动至下一条错误
• Export:将错误信息导出至本地,可选择导出为 HTML 或 XML 格式
• Edit Settings:编辑错误代码检查的设置文件
• Apply Quickfix:使用快速修正
您可以使用快速修正功能修正代码,也可以手动修改代码。

当然,您可以通过各种形式获取Cloud Toolkit
获取方式:
• IntelliJ IDEA版/PyCharm版本:
https://plugins.jetbrains.com/plugin/11386-alibaba-cloud-toolkit
• Visual Studio Code版本:
https://marketplace.visualstudio.com/items?itemName=alibabacloud-cloudtoolkit.toolkit-vscode
• Eclipse 版本:
https://marketplace.eclipse.org/content/alibaba-cloud-toolkit
• Maven 版本:
https://help.aliyun.com/document_detail/108682.html
使用教程:
https://help.aliyun.com/document_detail/147728.html?spm=a2c4g.11186623.6.541.1958602bbDiHei

目录
打赏
0
0
0
0
6180
分享
相关文章
JAVA接入DeepSeek大模型接口开发---阿里云的百炼模型
随着大模型的越来越盛行,现在很多企业开始接入大模型的接口,今天我从java开发角度来写一个demo的示例,用于接入DeepSeek大模型,国内的大模型有很多的接入渠道,今天主要介绍下阿里云的百炼模型,因为这个模型是免费的,只要注册一个账户,就会免费送百万的token进行学习,今天就从一个简单的可以执行的示例开始进行介绍,希望可以分享给各位正在学习的同学们。
124 3
JAVA接入DeepSeek大模型接口开发---阿里云的百炼模型
一天成为Java开发高手:用飞算JavaAI实现十倍提效
“一天成为Java开发高手”曾被视为天方夜谭,但飞算JavaAI的出现改变了这一局面。这款AI开发助手通过智能引导、需求分析、自动化逻辑处理和完整代码工程生成,大幅简化了Java开发流程。它不仅帮助新手快速上手,还让资深开发者提高效率,减少调试时间。现在,参与“飞算JavaAI炫技赛”,展示你的开发实力,赢取丰厚奖品!
【02】Java+若依+vue.js技术栈实现钱包积分管理系统项目-商业级电玩城积分系统商业项目实战-ui设计图figmaUI设计准备-figma汉化插件-mysql数据库设计-优雅草卓伊凡商业项目实战
【02】Java+若依+vue.js技术栈实现钱包积分管理系统项目-商业级电玩城积分系统商业项目实战-ui设计图figmaUI设计准备-figma汉化插件-mysql数据库设计-优雅草卓伊凡商业项目实战
110 14
【02】Java+若依+vue.js技术栈实现钱包积分管理系统项目-商业级电玩城积分系统商业项目实战-ui设计图figmaUI设计准备-figma汉化插件-mysql数据库设计-优雅草卓伊凡商业项目实战
智慧产科一体化管理平台源码,基于Java,Vue,ElementUI技术开发,二开快捷
智慧产科一体化管理平台覆盖从备孕到产后42天的全流程管理,构建科室协同、医患沟通及智能设备互联平台。通过移动端扫码建卡、自助报道、智能采集数据等手段优化就诊流程,提升孕妇就诊体验,并实现高危孕产妇五色管理和孕妇学校三位一体化管理,全面提升妇幼健康宣教质量。
57 12
课时146:使用JDT开发Java程序
在 Eclipse 之中提供有 JDT环境可以实现java 程序的开发,下面就通过一些功能进行演示。 项目开发流程
SaaS云计算技术的智慧工地源码,基于Java+Spring Cloud框架开发
智慧工地源码基于微服务+Java+Spring Cloud +UniApp +MySql架构,利用传感器、监控摄像头、AI、大数据等技术,实现施工现场的实时监测、数据分析与智能决策。平台涵盖人员、车辆、视频监控、施工质量、设备、环境和能耗管理七大维度,提供可视化管理、智能化报警、移动智能办公及分布计算存储等功能,全面提升工地的安全性、效率和质量。
Java高级应用开发:基于AI的微服务架构优化与性能调优
在现代企业级应用开发中,微服务架构虽带来灵活性和可扩展性,但也增加了系统复杂性和性能瓶颈。本文探讨如何利用AI技术,特别是像DeepSeek这样的智能工具,优化Java微服务架构。AI通过智能分析系统运行数据,自动识别并解决性能瓶颈,优化服务拆分、通信方式及资源管理,实现高效性能调优,助力开发者设计更合理的微服务架构,迎接未来智能化开发的新时代。
菜鸟之路day02-04拼图小游戏开发一一JAVA基础综合项目
本项目基于黑马程序员教程,涵盖面向对象进阶、继承、多态等知识,历时约24小时完成。项目去除了登录和注册模块,专注于单机游戏体验。使用Git进行版本管理,代码托管于Gitee。项目包含窗体搭建、事件监听、图片加载与打乱、交互逻辑实现、菜单功能及美化界面等内容。通过此项目,巩固了Java基础并提升了实际开发能力。 仓库地址:[https://gitee.com/zhang-tenglan/puzzlegame.git](https://gitee.com/zhang-tenglan/puzzlegame.git)
66 6
【潜意识Java】javaee中的SpringBoot在Java 开发中的应用与详细分析
本文介绍了 Spring Boot 的核心概念和使用场景,并通过一个实战项目演示了如何构建一个简单的 RESTful API。
61 5
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等