SAP官方发布的ABAP编程规范

待我称王封你为后i 2023-06-02 12:59 38阅读 0赞

最近有朋友在公众号后台给我留言，“Jerry啊，你最近写的都是一些SAP研究院里面用到的新技术，能不能写点SAP传统的开发技术比如ABAP相关的东西”？

![1240][]

其实Jerry在刚开始写这个公众号的时候，是写过很多ABAP的技术文章：

*  [Jerry的ABAP, Java和JavaScript乱炖][Jerry_ABAP_ Java_JavaScript]
 *  [ABAP开发人员未来应该学些什么][ABAP]
 *  [Jerry 2017年的五一小长假：][Jerry 2017][8种经典排序算法的ABAP实现][Jerry 2017]
 *  [Jerry的ABAP原创技术文章合集][Jerry_ABAP]
 *  [300行ABAP代码实现一个最简单的区块链原型][300_ABAP]
 *  [使用Java+SAP云平台+SAP Cloud Connector调用ABAP On-Premise系统里的函数][Java_SAP_SAP Cloud Connector_ABAP On-Premise]
 *  [在SAP云平台的CloudFoundry环境下消费ABAP On-Premise OData服务][SAP_CloudFoundry_ABAP On-Premise OData]
 *  [ABAP vs Java， 蛙泳 vs 自由泳][ABAP vs Java_ _ vs]
 *  [聊聊C语言和ABAP][C_ABAP]
 *  [动手使用ABAP Channel开发一些小工具，提升日常工作效率][ABAP Channel]
 *  [我用ABAP做过的那些无聊的事情][ABAP 1]
 *  [不喜欢SAP GUI？][SAP GUI][那试试用Eclipse进行ABAP开发吧][SAP GUI]
 *  [使用Visual Studio Code编写和激活ABAP代码][Visual Studio Code_ABAP]
 *  [你的ABAP程序给佛祖开过光么？][ABAP 2][来试试Jerry这个小技巧][ABAP 2]
 *  [在SAP云平台ABAP编程环境上编写第一段ABAP程序][SAP_ABAP_ABAP]

因为Jerry最近的工作，需要使用ABAP编程的场景不多，所以近期这方面的文章少了点。

在Jerry之前的文章 [写在Github被微软收购之际 - Github的那些另类用法][Github_ - Github] 曾经提到，SAP在Github上也有很多开源项目：

[https://github.com/sap][https_github.com_sap]

截至到今天(2019年7月26日)，已经有399个仓库了。

![1240][1240 1]

Jerry年初去成都天府软件园一家SAP partners公司拜访时，这家公司的技术主管曾经问过我，有没有推荐的ABAP编程规范。Jerry当时想了想，回答说，虽然SAP研究院内部确有严格清晰写成文档，多达七八十页的ABAP编程规则，但Jerry不确定这些编程规则是否能直接发给非SAP员工。

今天Jerry觉得这个问题我已经有完美的答案了：我们来聊聊上述SAP开源的Github仓库其中之一，包含了SAP官方推荐的ABAP编程规范：

[https://github.com/SAP/styleguides][https_github.com_SAP_styleguides]

![1240][1240 2]

cheat-sheet文件夹里主要包含了CleanABAPCheatSheet和CleanABAPTheGoldenRules两个文件，前者包含了SAP认为要写出Clean的ABAP代码，需要遵循的准则和尽量避免的误区。

![1240][1240 3]

而CleanABAPTheGoldenRules这个文件，包含的就是SAP推荐的关于ABAP编程方方面面的最佳准则：

![1240][1240 4]

而Sub-sections文件夹里包含了一些话题的深入阐述：

![1240][1240 5]

这些话题每一个都值得用一篇文章展开聊，Jerry先挖个坑在这里，有机会再填：

**Avoid Encodings**

SAP这个github文件给出的推荐是，建议在给方法实现里的变量名取名时，**避免使用前缀**。下图红色高亮的代码是推荐的做法，而黑色的代码是应该避免的代码。

![1240][1240 6]

这很有趣，因为Jerry在SAP内部做ABAP开发，遵循的原则恰恰就是第二种做法。

作者也深知这个建议和SAP官网help.sap.com上定义的ABAP编程规范里变量命名规范有相矛盾的地方，但还是坚持认为变量名不要前缀，是更加符合现代编程规范的做法，并且让变量有更好的可读性。

![1240][1240 7]

Jerry的个人意见是，对于SAP partners的开发团队来说，不必纠结到底应该遵循help.sap.com上的变量命名规范，还是应该按照本文介绍的SAP github上介绍的规范来——更重要的是，整个团队内部达成一致，选择一套坚决执行。

**Enumerations.md**

在ABAP里使用枚举类型的几种方式：

![1240][1240 8]

**Exceptions**

ABAP异常处理的最佳实践。

**Function Groups vs. Classes**

给了为什么坚决推荐不再使用function group / function module，而是鼓励大家投入到面向对象编程怀抱的原因。

**Modern ABAP Language Elements**

搜集了一些现代的ABAP语法和ABAP关键字的用法。

**Upper vs. Lower Case**

ABAP 语言的大小写规范，经常会让很多刚刚从其他编程语言转过来的程序员觉得摸不着头脑，Jerry当年刚刚从C++编程转到ABAP编程也是如此。

这个子话题给出了推荐的大小写使用场景。

因为Jerry的日常工作几乎不会用到ABAP，所以我也没有时间就这些话题深入展开，大家可以好好利用这个Github仓库，让自己的团队都能开发一套clean的ABAP代码出来，感谢阅读。

**更多阅读**

转载于:https://www.cnblogs.com/sap-jerry/p/11395260.html

[1240]: /images/20230601/e679d09303f14fc2b4e45082e8cd0c18.png
[Jerry_ABAP_ Java_JavaScript]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247483686&idx=1&sn=bbbf5ecf9cc3fa2a50545fafdb9c7417&chksm=ead5b3b1dda23aa782e8bf7006d73d19e61f5bf06fed80498eb189e5791b4973319cf48103f5&scene=21#wechat_redirect
[ABAP]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247483784&idx=1&sn=0a5ae8901d484f8b7442ba14c4c7069f&chksm=ead5b31fdda23a09b1d7ddbcb36d78750b0a3054f12447cd89021f3967a9912111a920e59375&scene=21#wechat_redirect
[Jerry 2017]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247483801&idx=1&sn=0536ce61c46f652ddeff8ba2081b54ce&chksm=ead5b30edda23a18f7db80e523c1f5345db12e585d37eba63128b01b18e8e170b2022ee716da&scene=21#wechat_redirect
[Jerry_ABAP]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247484051&idx=1&sn=39254eada3c01b5263cc800b18fabcad&chksm=ead5b004dda239122fbf842090e52991f36b4fb96a7ed4160928bebd03809ed2651297c66200&scene=21#wechat_redirect
[300_ABAP]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247484403&idx=1&sn=c2866d6f1701fefe09409ee12fc0a6e5&chksm=ead5b164dda23872d8095eca239a3fa37e83251eaec9a13d40e20755aa67dcc4a465e61b4250&scene=21#wechat_redirect
[Java_SAP_SAP Cloud Connector_ABAP On-Premise]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247484533&idx=1&sn=57587494ffa36fda4cd97afc3cb08716&chksm=ead5b6e2dda23ff4f9b3c6623aa381c3620e7e349c210bda0516291463de487846d89cc97e22&scene=21#wechat_redirect
[SAP_CloudFoundry_ABAP On-Premise OData]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247484794&idx=1&sn=c7bfd5adbd729cb7817238b3a822938b&chksm=ead5b7eddda23efbaf5b6cfc3acb13756dc0e17d2f7e73220b07ab68935aad07ecf8e39294de&scene=21#wechat_redirect
[ABAP vs Java_ _ vs]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247484972&idx=1&sn=a19867f267dea49185242ae87a5030fa&chksm=ead5b4bbdda23dadca4329107827e195f61f41a4b385276db54b913b8c5353754d66ed695829&scene=21#wechat_redirect
[C_ABAP]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247485325&idx=1&sn=475c9002831a7394035a022051bd3c28&chksm=ead5b51adda23c0c621db3f87356b00bd4a0916decaa8a5644badf53a2d6fa347cf432b28851&scene=21#wechat_redirect
[ABAP Channel]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247485364&idx=1&sn=609b1f44458a06c1ad1dcc783c3a5588&chksm=ead5b523dda23c3536d21cb36e74f7a2786a1298a99d2c8638eaea851ade1a8d275b3d6bcf01&scene=21#wechat_redirect
[ABAP 1]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247485401&idx=1&sn=36adda241cc6c2016a24edd3e9a406c7&chksm=ead5b54edda23c58bc0c760243e9cf6177444e7cfa5ad6870a1ecc682da1b86584327c1c838f&scene=21#wechat_redirect
[SAP GUI]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247485416&idx=1&sn=a6aa5df03b5fbf75b8060905b1f06e94&chksm=ead5b57fdda23c6999f72777a04891fc669120af3bbf7ba5e7991f798604913589f748e8261a&scene=21#wechat_redirect
[Visual Studio Code_ABAP]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247486027&idx=1&sn=dad3813a48717c48c8798db7d7c1c5c5&chksm=ead5b8dcdda231ca18b9c0771cdc125f65104160c512dc8208896fc67c56504ec9623348e056&scene=21#wechat_redirect
[ABAP 2]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247486101&idx=1&sn=1ee953ecce085e5a727498a5e0655db4&chksm=ead5b802dda2311431e307b9acc91f6dd5466b3f0208942960634eaa066994622afdd5297e31&scene=21#wechat_redirect
[SAP_ABAP_ABAP]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247486298&idx=1&sn=f056141e3ae53adf45a4c6758ae73fa6&chksm=ead5b9cddda230db8b604442f057acbbf1d169c1e719b72464f1f214218cf829a1b9bc7b1a01&scene=21#wechat_redirect
[Github_ - Github]: http://mp.weixin.qq.com/s?__biz=MzI3MDE4MjM5Mg==&mid=2247484762&idx=1&sn=042015f84f84023f303c9dc9823a10b9&chksm=ead5b7cddda23edb4b5b39c80fe1b2d19663b200e6177f5e0b06adfa3addcd680e82ed6eaaea&scene=21#wechat_redirect
[https_github.com_sap]: https://github.com/sap
[1240 1]: /images/20230601/65d1d9567b2a48ee95e218c7debd5694.png
[https_github.com_SAP_styleguides]: https://github.com/SAP/styleguides
[1240 2]: /images/20230601/b4c7189a5ab2465cb72f7a05027b65df.png
[1240 3]: /images/20230601/84976c76962341e4af76569e004691ff.png
[1240 4]: /images/20230601/d4055939d32b404ca5c4dcf9b103c9f2.png
[1240 5]: /images/20230601/7ae9216731924df783d26b3dceed76d4.png
[1240 6]: /images/20230601/fe7e6dd78a764a5bacd5714bb11bbf45.png
[1240 7]: /images/20230601/bcf201e7a23b4b5a98654edd6631cecf.png
[1240 8]: /images/20230601/28961e2e028b4f2fbecb6c87447a17fe.png