Android命名规范

    xiaoxiao2021-03-25  148

    1.约定

    onCreate(),onActivityCreated(),紧跟成员变量后,方法内部保持简单,尽量只调用initXXX()方法,如:initData(),initView()。调用方法保持“临近原则”,被调用的方法,放在调用方法下方单个方法体不要过长代码任何地方不要拼错单词

    2.命名

    2.1.布局文件中的id命名

    规则:使用驼峰命名,前缀+逻辑名称,类变量名和布局文件id名称保持一致,不需要下划线分割

    控件缩写前缀TextView/EditTexttv/etImageViewivButton/RadioButton/ImageButtonbtRelativeLayout/LinearLayout/FrameLayout rl/ll/flListViewlvWebViewwvCheckBoxcbProgressBarpbseekBarsb其他控件控件名首字母拼接作为前缀 如:TextView @+id/tvTitle如:EditView @+id/evName如:Button @+id/btSearch

    2.2.布局文件命名

    规则: 使用 前缀_逻辑名称 命名,单词全部小写,单词间以 下划线 分割。

    布局类型布局前缀Activityactivity_Fragmentfragment_Include include_Dialogdialog_PopupWindowpopup_Menumenu_Adapterlayout_item_

    2.3.资源文件命名

    规则: 使用 前缀_用途 命名,单词全部小写,单词间以 下划线 分割。

    图片资源文件命名 前缀说明bg_xxx各类背景图片btn_xxx这种按钮没有其他状态ic_xxx 图标,一般用于单个图标bg_描述_状态1[_状态2] 用于控件上的不同状态btn_描述_状态1[_状态2]用于按钮上的不同状态chx_描述_状态1[_状态2]选择框,一般有2态和4态 第三方资源文件,不管在value、drawab 必须携带第三方资源前缀umeng_socialize_style.xmlpull_refresh_attrs.xml

    2.4. 类和接口命名

    规则: 使用驼峰规则,首字母必须大写,使用名词或名词词组。要求简单易懂,富于描述,不允许出现无意义或错误单词。

    类 描述 例如Application类 Application为后缀标识 XXXApplicationActivity类Activity为后缀标识闪屏页面类SplashActivity解析类Handler为后缀标识 公共方法类Utils或Manager为后缀标识 XxxUtils线程池管理类ThreadPoolManager日志工具类LogUtils数据库类以DBHelper后缀标识MySQLiteDBHelperService类以Service为后缀标识播放服务:PlayServiceBroadcastReceiver类以Broadcast为后缀标识时间通知:TimeBroadcastContentProvider类以Provider为后缀标识单词内容提供者:DictProvider直接写的共享基础类以Base为前缀BaseActivity,BaseFragment

    2.5. 方法的命名

    规则: 使用驼峰规则,首字母必须小写,使用动词。要求简单易懂,富于描述,不允许出现无意义或错误单词。

    方法说明initXX()初始化相关方法,使用init为前缀标识,如初始化布局initView()httpXX()http业务请求方法,以http为前缀标识getXX()返回某个值的方法,使用get为前缀标识saveXX() 与保存数据相关的,使用save为前缀标识deleteXX() 删除操作resetXX()对数据重组的,使用reset前缀标识clearXX() 清除数据相关的isXX()方法返回值为boolean型的请使用is或check为前缀标识processXX() 对数据进行处理的方法,尽量使用process为前缀标识displayXX()弹出提示框和提示信息,使用display为前缀标识drawXXX()绘制数据或效果相关的,使用draw前缀标识

    2.5. 变量命名

    规则: 使用驼峰规则,首字母必须小写,使用名词或名词词组。要求简单易懂,富于描述,不允许出现无意义或错误单词。

    成员变量命名,自定义变量前添加m前缀,布局控件变量不用添加m前缀常量命名,全部大写,单词间用下划线隔开

    3. 其他规范

    Activity继承BaseFragmentActivity或SwipeBackActivity,可以使用ButterKnife注解代替findViewById方法 拆分臃肿方法,每个方法只作一件事做同一个逻辑的方法,尽量靠近放到一块,方便查看不要使用 try catch 处理业务逻辑使用JSON工具类,不要手动解析和拼装数据控制语句 减少条件嵌套,不要超过3层if语句必须用{}包括起来,即便是只有一句处理“魔数”等看不懂的神秘数字 代码中不要出现数字,特别是一些标识不同类型的数字。所有意义数字全部抽取到Constant公共类中,避免散布在各位类中。空行:空行将逻辑相关代码段隔开,简洁清楚,提高可读性 成员变量之间,根据业务形成分组加空行方法之间加空行用好TODO标记 记录想法,记录功能点,开发过程中可以利用TODO记录一下临时想法或为了不打扰思路留下待完善的说明删除无用TODO,开发工具自动生成的TODO,或则已经完善的TODO,一定要删除。

    4. IDE

    Android Studio 当前最新稳定版本统一code style文件

    以下为AndroidModernStyle.xml文件:


    <code_scheme name="AndroidModernStyle"> <option name="OTHER_INDENT_OPTIONS"> <value> <option name="INDENT_SIZE" value="2" /> <option name="CONTINUATION_INDENT_SIZE" value="4" /> <option name="TAB_SIZE" value="2" /> <option name="USE_TAB_CHARACTER" value="false" /> <option name="SMART_TABS" value="false" /> <option name="LABEL_INDENT_SIZE" value="0" /> <option name="LABEL_INDENT_ABSOLUTE" value="false" /> <option name="USE_RELATIVE_INDENTS" value="false" /> </value> </option> <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999" /> <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999" /> <option name="PACKAGES_TO_USE_IMPORT_ON_DEMAND"> <value /> </option> <option name="IMPORT_LAYOUT_TABLE"> <value> <package name="android" withSubpackages="true" static="false" /> <emptyLine /> <package name="com" withSubpackages="true" static="false" /> <emptyLine /> <package name="junit" withSubpackages="true" static="false" /> <emptyLine /> <package name="net" withSubpackages="true" static="false" /> <emptyLine /> <package name="org" withSubpackages="true" static="false" /> <emptyLine /> <package name="java" withSubpackages="true" static="false" /> <emptyLine /> <package name="javax" withSubpackages="true" static="false" /> <emptyLine /> <package name="" withSubpackages="true" static="false" /> <emptyLine /> <package name="" withSubpackages="true" static="true" /> <emptyLine /> </value> </option> <option name="RIGHT_MARGIN" value="100" /> <option name="JD_ALIGN_PARAM_COMMENTS" value="false" /> <option name="JD_ALIGN_EXCEPTION_COMMENTS" value="false" /> <option name="JD_P_AT_EMPTY_LINES" value="false" /> <option name="JD_DO_NOT_WRAP_ONE_LINE_COMMENTS" value="true" /> <option name="JD_KEEP_EMPTY_PARAMETER" value="false" /> <option name="JD_KEEP_EMPTY_RETURN" value="false" /> <option name="JD_PRESERVE_LINE_FEEDS" value="true" /> <option name="HTML_KEEP_BLANK_LINES" value="1" /> <option name="WRAP_COMMENTS" value="true" /> <AndroidXmlCodeStyleSettings> <option name="USE_CUSTOM_SETTINGS" value="true" /> <option name="LAYOUT_SETTINGS"> <value> <option name="INSERT_BLANK_LINE_BEFORE_TAG" value="false" /> <option name="INSERT_LINE_BREAK_AFTER_LAST_ATTRIBUTE" value="true" /> </value> </option> <option name="MANIFEST_SETTINGS"> <value> <option name="INSERT_LINE_BREAK_AFTER_LAST_ATTRIBUTE" value="true" /> </value> </option> <option name="OTHER_SETTINGS"> <value> <option name="INSERT_LINE_BREAK_AFTER_LAST_ATTRIBUTE" value="true" /> </value> </option> </AndroidXmlCodeStyleSettings> <JavaCodeStyleSettings> <option name="CLASS_NAMES_IN_JAVADOC" value="3" /> </JavaCodeStyleSettings> <XML> <option name="XML_KEEP_BLANK_LINES" value="1" /> <option name="XML_LEGACY_SETTINGS_IMPORTED" value="true" /> </XML> <codeStyleSettings language="Groovy"> <option name="KEEP_LINE_BREAKS" value="false" /> <option name="KEEP_FIRST_COLUMN_COMMENT" value="false" /> <option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1" /> <option name="KEEP_BLANK_LINES_IN_CODE" value="1" /> <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1" /> <indentOptions> <option name="INDENT_SIZE" value="2" /> <option name="CONTINUATION_INDENT_SIZE" value="4" /> <option name="TAB_SIZE" value="2" /> </indentOptions> </codeStyleSettings> <codeStyleSettings language="HTML"> <indentOptions> <option name="INDENT_SIZE" value="2" /> <option name="CONTINUATION_INDENT_SIZE" value="4" /> <option name="TAB_SIZE" value="2" /> </indentOptions> </codeStyleSettings> <codeStyleSettings language="JAVA"> <option name="LINE_COMMENT_AT_FIRST_COLUMN" value="false" /> <option name="BLOCK_COMMENT_AT_FIRST_COLUMN" value="false" /> <option name="KEEP_FIRST_COLUMN_COMMENT" value="false" /> <option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false" /> <option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1" /> <option name="KEEP_BLANK_LINES_IN_CODE" value="1" /> <option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1" /> <option name="ALIGN_MULTILINE_PARAMETERS" value="false" /> <option name="ALIGN_MULTILINE_FOR" value="false" /> <option name="SPACE_WITHIN_ARRAY_INITIALIZER_BRACES" value="true" /> <option name="SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE" value="true" /> <option name="CALL_PARAMETERS_WRAP" value="1" /> <option name="METHOD_PARAMETERS_WRAP" value="1" /> <option name="RESOURCE_LIST_WRAP" value="1" /> <option name="EXTENDS_LIST_WRAP" value="1" /> <option name="THROWS_LIST_WRAP" value="1" /> <option name="EXTENDS_KEYWORD_WRAP" value="1" /> <option name="THROWS_KEYWORD_WRAP" value="1" /> <option name="METHOD_CALL_CHAIN_WRAP" value="5" /> <option name="BINARY_OPERATION_WRAP" value="1" /> <option name="BINARY_OPERATION_SIGN_ON_NEXT_LINE" value="true" /> <option name="TERNARY_OPERATION_WRAP" value="1" /> <option name="TERNARY_OPERATION_SIGNS_ON_NEXT_LINE" value="true" /> <option name="KEEP_SIMPLE_METHODS_IN_ONE_LINE" value="true" /> <option name="KEEP_SIMPLE_CLASSES_IN_ONE_LINE" value="true" /> <option name="FOR_STATEMENT_WRAP" value="1" /> <option name="ARRAY_INITIALIZER_WRAP" value="1" /> <option name="ASSERT_STATEMENT_WRAP" value="1" /> <option name="IF_BRACE_FORCE" value="3" /> <option name="DOWHILE_BRACE_FORCE" value="3" /> <option name="WHILE_BRACE_FORCE" value="3" /> <option name="FOR_BRACE_FORCE" value="3" /> <option name="FIELD_ANNOTATION_WRAP" value="1" /> <option name="PARAMETER_ANNOTATION_WRAP" value="1" /> <option name="VARIABLE_ANNOTATION_WRAP" value="1" /> <indentOptions> <option name="INDENT_SIZE" value="2" /> <option name="CONTINUATION_INDENT_SIZE" value="4" /> <option name="TAB_SIZE" value="2" /> </indentOptions> </codeStyleSettings> <codeStyleSettings language="XML"> <option name="FORCE_REARRANGE_MODE" value="1" /> <indentOptions> <option name="INDENT_SIZE" value="2" /> <option name="CONTINUATION_INDENT_SIZE" value="2" /> <option name="TAB_SIZE" value="2" /> </indentOptions> <arrangement> <rules> <section> <rule> <match> <AND> <NAME>xmlns:android</NAME> <XML_NAMESPACE>.*</XML_NAMESPACE> </AND> </match> </rule> </section> <section> <rule> <match> <AND> <NAME>xmlns:.*</NAME> <XML_NAMESPACE>.*</XML_NAMESPACE> </AND> </match> <order>BY_NAME</order> </rule> </section> <section> <rule> <match> <AND> <NAME>.*:id</NAME> <XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE> </AND> </match> </rule> </section> <section> <rule> <match> <AND> <NAME>.*:name</NAME> <XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE> </AND> </match> </rule> </section> <section> <rule> <match> <AND> <NAME>name</NAME> <XML_NAMESPACE>^$</XML_NAMESPACE> </AND> </match> </rule> </section> <section> <rule> <match> <AND> <NAME>style</NAME> <XML_NAMESPACE>^$</XML_NAMESPACE> </AND> </match> </rule> </section> <section> <rule> <match> <AND> <NAME>.*</NAME> <XML_NAMESPACE>^$</XML_NAMESPACE> </AND> </match> <order>BY_NAME</order> </rule> </section> <section> <rule> <match> <AND> <NAME>.*:orientation</NAME> <XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE> </AND> </match> </rule> </section> <section> <rule> <match> <AND> <NAME>.*:layout_width</NAME> <XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE> </AND> </match> </rule> </section> <section> <rule> <match> <AND> <NAME>.*:layout_height</NAME> <XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE> </AND> </match> </rule> </section> <section> <rule> <match> <AND> <NAME>.*:layout_weight</NAME> <XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE> </AND> </match> </rule> </section> <section> <rule> <match> <AND> <NAME>.*:layout_.*</NAME> <XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE> </AND> </match> <order>BY_NAME</order> </rule> </section> <section> <rule> <match> <AND> <NAME>.*:width</NAME> <XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE> </AND> </match> <order>BY_NAME</order> </rule> </section> <section> <rule> <match> <AND> <NAME>.*:height</NAME> <XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE> </AND> </match> <order>BY_NAME</order> </rule> </section> <section> <rule> <match> <AND> <NAME>.*</NAME> <XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE> </AND> </match> <order>BY_NAME</order> </rule> </section> <section> <rule> <match> <AND> <NAME>.*</NAME> <XML_NAMESPACE>.*</XML_NAMESPACE> </AND> </match> <order>BY_NAME</order> </rule> </section> </rules> </arrangement> </codeStyleSettings> </code_scheme>

    Mac下Android Studio Code style添加方法

    找到自己Android studio的资源目录 /Library/Preferences/AndroidStudio2.3/codestyles将上述AndroidModernStyle.xml文件放到上面的codestyles目录重新启动Android StudioPreferences/Code Style菜单,右侧Scheme下拉列表找到刚刚添加的AndroidModernStyle。点击右下角ok

    Windows下Android Studio Code style添加方法


    下载 code style文件另存为AndroidModernStyle.xml在Android Studio中打开设置界面,代码风格点击Scheme后方的Manager按钮,在列表框中选择Import,选择文件所在位置一路next,导入后在Scheme处选择AndroidModernStyle,右下方ok

    转载请注明原文地址: https://ju.6miu.com/read-17670.html

    最新回复(0)