ABAP编程命名规范

Bertha 。 2023-06-14 10:47 72阅读 0赞

# 0. 通用前缀 #

通用前缀是标识代码用途的重要手段，通常在项目中会以项目名作为一种通用的前缀；在SAP系统中也是类似的，例如使用FI，MM等模块作为通用前缀。

*  SAP前缀举例：FI\_xxx
 *  项目前缀举例：ABC\_xxx

通用前缀在下文将使用**<general prefix>或<prefix>**表示。

*注：对于客户定制的代码，对象的命名空间为Y或Z。*

# 1. 类的命名（Class） #

## 1.1 全局类 (Global Class) ##

<table> 
 <thead> 
  <tr> 
   <th> <p>Name</p> </th> 
   <th> <p>Class</p> </th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td colspan="1">CL_&lt;prefix&gt;_</td> 
   <td colspan="1">Standard Class</td> 
  </tr> 
  <tr> 
   <td colspan="1">CF_&lt;prefix&gt;</td> 
   <td colspan="1">Factory Class</td> 
  </tr> 
  <tr> 
   <td colspan="1">CX_&lt;prefix&gt;_</td> 
   <td colspan="1">Exception Class</td> 
  </tr> 
  <tr> 
   <td colspan="1">IF_&lt;prefix&gt;_</td> 
   <td colspan="1">Interface</td> 
  </tr> 
  <tr> 
   <td colspan="1">TC_&lt;prefix&gt;_</td> 
   <td colspan="1">Global Test Class</td> 
  </tr> 
  <tr> 
   <td colspan="1">TD_&lt;prefix&gt;_</td> 
   <td colspan="1">Global Test Double&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">TH_&lt;prefix&gt;_&nbsp;</td> 
   <td colspan="1">Global Test Helper Class</td> 
  </tr> 
 </tbody> 
</table>

## 1.2 局部类（Local Class） ##

<table> 
 <thead> 
  <tr> 
   <th> <p>Name</p> </th> 
   <th> <p>Class</p> </th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td colspan="1">LCL_</td> 
   <td colspan="1">General local class</td> 
  </tr> 
  <tr> 
   <td colspan="1">LTC_</td> 
   <td colspan="1">ABAPUnit: Test class</td> 
  </tr> 
  <tr> 
   <td colspan="1">LTD_</td> 
   <td colspan="1">ABAPUnit: Test Double</td> 
  </tr> 
  <tr> 
   <td colspan="1">LTH_</td> 
   <td colspan="1">ABAPUnit: Helper Class</td> 
  </tr> 
 </tbody> 
</table>

## 1.3 方法名 （Methods） ##

<table> 
 <thead> 
  <tr> 
   <th> <p>Type</p> </th> 
   <th> <p>Pattern</p> </th> 
   <th colspan="1"> <p>Examples</p> </th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>变量访问 Attribute Accesses</td> 
   <td> <p>SET_&lt;attribute_name&gt;</p> <p>GET_&lt;attribute_name&gt;</p> </td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">Check方法 (with exceptions)&nbsp;</td> 
   <td colspan="1">CHECK_&lt;objective&gt;</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">事件 Events</td> 
   <td colspan="1">&lt;noun&gt;_&lt;participle&gt;</td> 
   <td colspan="1">BUTTON_PUSHED, DOCUMENT_POSTED</td> 
  </tr> 
  <tr> 
   <td colspan="1">通用方法 General Methods</td> 
   <td colspan="1">&lt;verb&gt;_&lt;noun&gt;</td> 
   <td colspan="1">GET_STATUS, DETERMINE_DUE_DATE</td> 
  </tr> 
  <tr> 
   <td colspan="1"> <p>返回方法 Return&nbsp;a boolean value<br> (without exceptions)</p> </td> 
   <td colspan="1"> <p>IS_&lt;adjective&gt;</p> <p>HAS_&lt;adjective&gt;</p> <p>EXISTS_&lt;adjective&gt;</p> </td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td> <p>事件响应方法</p> <p>Methods that handle an event</p> </td> 
   <td> <p>ON_&lt;event_name&gt;</p> </td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

# 2. 属性命名和变量命名 #

通用的命名规则即：***<Attribute Type><Data Type>\_***

## 2.1 属性类型的命名 ##

<table> 
 <thead> 
  <tr> 
   <th colspan="1" style="width:164px;"> <p>&lt;Attribute Type&gt;</p> </th> 
   <th colspan="1" style="width:236px;"> <p>Description</p> </th> 
   <th colspan="1"> <p>Remarks</p> </th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td colspan="1" style="width:164px;">G</td> 
   <td style="width:236px;"><strong>G</strong>lobal Attribute</td> 
   <td colspan="1">Constants, Static attributes</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="width:164px;">M</td> 
   <td colspan="1" style="width:236px;">Instance Attribute</td> 
   <td colspan="1">Object <strong>m</strong>ember</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="width:164px;">L&nbsp;</td> 
   <td colspan="1" style="width:236px;"><strong>L</strong>ocal Attribute&nbsp;</td> 
   <td colspan="1">Declared in method, form,&nbsp;function module, etc.</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="width:164px;">I&nbsp;</td> 
   <td colspan="1" style="width:236px;"><strong>I</strong>mporting Parameter&nbsp;</td> 
   <td colspan="1">Interface of method, form, function module</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="width:164px;">E&nbsp;</td> 
   <td colspan="1" style="width:236px;"><strong>E</strong>xporting&nbsp;Parameter&nbsp;</td> 
   <td colspan="1">Interface of method, form, function module&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="width:164px;">C&nbsp;</td> 
   <td colspan="1" style="width:236px;"><strong>C</strong>hanging Parameter&nbsp;</td> 
   <td colspan="1">Interface of method, form, function module</td> 
  </tr> 
  <tr> 
   <td colspan="1" style="width:164px;">R&nbsp;</td> 
   <td colspan="1" style="width:236px;"><strong>R</strong>eturning&nbsp;Parameter&nbsp;</td> 
   <td colspan="1">Interface of method&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

## 2.2 数据类型的标识 ##

<table> 
 <thead> 
  <tr> 
   <th colspan="1"> <p>&lt;Data Type&gt;</p> </th> 
   <th colspan="1"> <p>Description</p> </th> 
   <th colspan="1"> <p>Remarks</p> </th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td colspan="1">C</td> 
   <td><strong>C</strong>onstant</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">D</td> 
   <td colspan="1"><strong>D</strong>ata</td> 
   <td colspan="1">Only relevant for parameters or field symbols with a generic type</td> 
  </tr> 
  <tr> 
   <td colspan="1">O</td> 
   <td colspan="1"><strong>O</strong>bject Reference</td> 
   <td colspan="1">Ref to class, interface, BAdI</td> 
  </tr> 
  <tr> 
   <td colspan="1">R</td> 
   <td colspan="1">Data <strong>R</strong>eference</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">S</td> 
   <td colspan="1"><strong>S</strong>tructure</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">T</td> 
   <td colspan="1">Internal <strong>T</strong>able</td> 
   <td colspan="1">Table, Range (internal tables with special structure)</td> 
  </tr> 
  <tr> 
   <td colspan="1">V</td> 
   <td colspan="1">Field</td> 
   <td colspan="1">Any atomic <strong>v</strong>alue type (string, char, numc, int, dec, float, ...)</td> 
  </tr> 
  <tr> 
   <td colspan="1">X</td> 
   <td colspan="1">Object Reference to E<strong>x</strong>ception Class</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

## 2.3 命名举例 ##

<table> 
 <tbody> 
  <tr> 
   <td>iv_value_date</td> 
   <td>date for value date field as an importing parameter</td> 
  </tr> 
  <tr> 
   <td>es_result</td> 
   <td>a strucute as a exporting parameter&nbsp;</td> 
  </tr> 
  <tr> 
   <td>ct_name</td> 
   <td>an internal table as changing parameter with names</td> 
  </tr> 
  <tr> 
   <td>mo_instance</td> 
   <td>an object as a class's attribute</td> 
  </tr> 
  <tr> 
   <td colspan="1">&lt;ls_invoice&gt;</td> 
   <td colspan="1">invoice structure as a locally used field-symbol</td> 
  </tr> 
  <tr> 
   <td colspan="1">gc_costc_main</td> 
   <td colspan="1">main cost center defined as a global constant</td> 
  </tr> 
 </tbody> 
</table>

# 3. 数据类型的定义命名 #

<table> 
 <thead> 
  <tr> 
   <th> <p>Prefix</p> </th> 
   <th> <p>Type</p> </th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td colspan="1">TY_</td> 
   <td colspan="1">Field</td> 
  </tr> 
  <tr> 
   <td colspan="1">TS_</td> 
   <td colspan="1">Structure</td> 
  </tr> 
  <tr> 
   <td colspan="1"> <p>TT_</p> </td> 
   <td colspan="1"> <p>Standard Table, Index Table</p> </td> 
  </tr> 
  <tr> 
   <td colspan="1">TTS_</td> 
   <td colspan="1">Sorted Table&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">TTH_</td> 
   <td colspan="1">Hashed&nbsp;Table</td> 
  </tr> 
  <tr> 
   <td colspan="1">TTA_</td> 
   <td colspan="1">Any Table</td> 
  </tr> 
  <tr> 
   <td colspan="1">TM_</td> 
   <td colspan="1">Mesh</td> 
  </tr> 
 </tbody> 
</table>

# 4. DDIC数据字典对象 #

<table> 
 <thead> 
  <tr> 
   <th colspan="1"> <p>Object</p> </th> 
   <th> <p>Prefix</p> </th> 
   <th colspan="1"> <p>Remarks</p> </th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td colspan="1">Database Table</td> 
   <td>&lt;general_prefix&gt;_&nbsp;</td> 
   <td colspan="1">Short version of general prefixed used because table name length is rather short.</td> 
  </tr> 
  <tr> 
   <td colspan="1">Views</td> 
   <td colspan="1">V_&lt;table name&gt;&nbsp;</td> 
   <td colspan="1">Name of the leading table&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">View Cluster</td> 
   <td colspan="1">VC_&lt;name&gt;</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">Data Elements, Domains</td> 
   <td>&lt;general_prefix&gt;_</td> 
   <td colspan="1">If Domain only used for one data element then domain name should be same as data element.</td> 
  </tr> 
  <tr> 
   <td colspan="1">Structures</td> 
   <td>&lt;general_prefix&gt;_S_</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">Range Structures</td> 
   <td>&lt;general_prefix&gt;_S_RANGE_</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">Table Types</td> 
   <td>&lt;general_prefix&gt;_T_</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td>Enqueue Objects</td> 
   <td>E&lt;general_prefix&gt;_</td> 
   <td>&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

# 5. 屏幕的parameter和select-options #

<table> 
 <thead> 
  <tr> 
   <th colspan="1"> <p>Prefix</p> </th> 
   <th colspan="1"> <p>Description</p> </th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td colspan="1">P_</td> 
   <td>Parameters</td> 
  </tr> 
  <tr> 
   <td colspan="1">S_</td> 
   <td colspan="1">Select-Options</td> 
  </tr> 
 </tbody> 
</table>

# 6. 其它数据对象 #

<table> 
 <thead> 
  <tr> 
   <th colspan="1"> <p>Object</p> </th> 
   <th> <p>Prefix</p> </th> 
   <th colspan="1"> <p>Remarks</p> </th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td colspan="1">Message Classes, Reports, Transactions</td> 
   <td>&lt;general prefix&gt;_</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">Includes</td> 
   <td>I&lt;general&nbsp;prefix&gt;_&nbsp;</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">Includes for unit tests</td> 
   <td colspan="1">UT_&lt;general prefix&gt;_</td> 
   <td colspan="1">Same name as for class to be tested. Instead of CL_ use UT_</td> 
  </tr> 
  <tr> 
   <td colspan="1">PFCG Roles</td> 
   <td colspan="1">&lt;general_prefix&gt;_</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
  <tr> 
   <td colspan="1">Authorization Objects</td> 
   <td colspan="1">F_&lt;general prefix&gt;_</td> 
   <td colspan="1">&nbsp;</td> 
  </tr> 
 </tbody> 
</table>