Skip to content

Latest commit

 

History

History
35 lines (33 loc) · 3.34 KB

依赖库开发规范指导.md

File metadata and controls

35 lines (33 loc) · 3.34 KB

依赖库github开发提交规范

依赖库开发官方指导: https://community.codewave.163.com/CommunityParent/fileIndex?filePath=40.%E6%89%A9%E5%B1%95%E4%B8%8E%E9%9B%86%E6%88%90%2F10.%E6%89%A9%E5%B1%95%E5%BC%80%E5%8F%91%E6%96%B9%E5%BC%8F%2F10.%E4%BB%80%E4%B9%88%E6%98%AF%E6%89%A9%E5%B1%95%E5%BC%80%E5%8F%91.md 后端代码开发需遵守阿里巴巴Java开发手册:https://alibaba.github.io/p3c/ 使用idea开发时建议安装对应插件,以下为补充规范。

开发规范

需求设计

应避免与当前低代码平台已有功能冲突,不引用制品工程的application.yml里的值,也不使用反射调用制品工程的代码。 内置函数和官方依赖库已有的功能无需重新开发,详见IDE内置函数组件和官方资产市场 避免不必要的方法设计,若能通过IDE功能和依赖库方法实现,则无需新增方法。例如,如果依赖库已有单个查询的方法,若批量查询方法只是使用单个查询方法进行循环则无需再开发 考虑制品导出源码独立部署的情况,比如在私有化部署可能无法访问外部接口 在升级依赖库版本时,需兼容之前版本的方法。不推荐使用的方法应使用@Deprecated标记,避免升级依赖库版本后需要重写逻辑。

代码开发

包名避免使用com.netease/com.netease.lowcode,因为一个制品可以引入多个依赖库可能导致全类名重复 在pom文件中,GroupID和ArtifactID必须保持唯一性。为避免ArtifactID重名情况,应避免过多使用"com.netease/com.netease.lowcode"作为GroupID,以免与其他开发者造成重复 在使用代码开发连接器时,@NaslConnector中的connectorKind必须保证唯一,可使用GroupID+ArtifactID,中间使用中划线分隔 所有依赖库方法必须具备方法注释,包括入参和出参的说明。同时,所有定义的结构体都必须添加注释。此外,pom文件中必须包含name标签和description标签。这些信息将被脚手架获取,并在低代码页面上展示。 处理关键参数时务必添加日志记录 单元测试必须做到全覆盖

附1:相关链接

服务端依赖库常见问题与故障排查

https://community.codewave.163.com/CommunityParent/fileIndex?filePath=40.%E6%89%A9%E5%B1%95%E4%B8%8E%E9%9B%86%E6%88%90%2F10.%E6%89%A9%E5%B1%95%E5%BC%80%E5%8F%91%E6%96%B9%E5%BC%8F%2F30.%E6%9C%8D%E5%8A%A1%E7%AB%AF%E6%89%A9%E5%B1%95%E5%BC%80%E5%8F%91%2F10.%E4%BE%9D%E8%B5%96%E5%BA%93%E5%BC%80%E5%8F%91%2F40.%E6%9C%8D%E5%8A%A1%E7%AB%AF%E4%BE%9D%E8%B5%96%E5%BA%93FAQ.md&version=3.7 官方资产市场 https://community.codewave.163.com/CommunityParent/CodeWaveMarke README.md参考 https://github.com/netease-lcap/CodeWaveAssetCompetition2024/blob/main/%E5%90%8E%E7%AB%AFreadme%E6%A8%A1%E6%9D%BF%E3%80%90%E5%8B%BF%E5%88%A0%E3%80%91 依赖库使用文档说明参考 https://community.codewave.163.com/CommunityParent/CodeWareMarketLibraryDetail?id=2745837804885504&isLatest=false&isClassics=

附2:本文档专有名词

依赖库:开发者可自行编写Java代码,定制出平台中的逻辑、数据结构、自定义参数配置,打包成为扩展依赖库并导入到平台IDE中使用,本文档中依赖库也可指使用Java代码开发的连接器 制品:低代码应用

附3:依赖库推荐引包版本列表

依赖库推荐引包版本列表