Android 命名规范（提高代码可以读性）

封面图 • 2025-10-05 • Android开发

在 Android 开发中，遵循良好的命名规范可以显著提高代码的可读性和可维护性。以下是一些常见的命名规范建议，涵盖变量、类、方法、资源文件等各个方面：

---

## 一、Java/Kotlin 变量和方法命名规范

### 1. **变量名**
- 使用**小驼峰命名法（lowerCamelCase）**。
- 名字应清晰表达其用途。

**示例：**
```java
int userAge;
String userName;
boolean isLogin;
```

### 2. **常量（final static）**
- 使用**全大写 + 下划线分隔（UPPER_SNAKE_CASE）**。

**示例：**
```java
public static final int MAX_RETRY_COUNT = 5;
public static final String APP_NAME = "MyApp";
```

### 3. **方法名**
- 使用**小驼峰命名法（lowerCamelCase）**。
- 方法名应描述其功能，如 `getUsername()`、`saveData()` 等。

**示例：**
```java
public void startService();
private boolean isValidEmail(String email);
```

### 4. **类名**
- 使用**大驼峰命名法（UpperCamelCase）**。
- 类名应为名词或名词短语。

**示例：**
```java
public class User;
public class LoginActivity;
public class NetworkManager;
```

### 5. **包名**
- 使用**小写字母 + 点号分隔（lowercase.dotted.case）**。
- 包名通常以域名倒置开头（如 `com.example.myapp`）。

**示例：**
```java
com.example.myapp.model
com.example.myapp.ui
com.example.myapp.util
```

---

## 二、Android 资源文件命名规范

### 1. **布局文件（XML）**
- 使用**小驼峰命名法（lowerCamelCase）**。
- 命名应体现页面或组件的功能。

**示例：**
```xml
activity_main.xml
fragment_profile.xml
item_post.xml
```

### 2. **字符串资源（strings.xml）**
- 使用**小写下划线命名法（snake_case）**。
- 每个字符串应有明确的含义。

**示例：**
```xml
<string name="app_name">My App</string>
<string name="welcome_message">Welcome to our app!</string>
```

### 3. **图片资源（drawable）**
- 使用**小写下划线命名法（snake_case）**。
- 命名应体现图片内容或用途。

**示例：**
```xml
ic_home.png
icon_user.png
bg_gradient.png
```

### 4. **颜色资源（colors.xml）**
- 使用**小写下划线命名法（snake_case）**。
- 表达颜色用途或主题。

**示例：**
```xml
<color name="color_primary">#FF0000</color>
<color name="text_secondary">#888888</color>
```

### 5. **尺寸资源（dimens.xml）**
- 使用**小写下划线命名法（snake_case）**。
- 表达具体尺寸用途。

**示例：**
```xml
<dimen name="padding_large">16dp</dimen>
<dimen name="font_size_small">12sp</dimen>
```

---

## 三、Kotlin 特殊命名规范（可选）

- Kotlin 支持更简洁的语法，但仍然推荐使用上述命名方式。
- 对于函数参数，也可以使用小驼峰命名。

**示例：**
```kotlin
fun calculateDiscount(price: Double, discountRate: Double): Double {
    return price * (1 - discountRate)
}
```

---

## 四、其他建议

| 项目 | 建议 |
|------|------|
| 注释 | 保持注释清晰，说明复杂逻辑或关键点 |
| 代码结构 | 按模块划分（如 `model`, `view`, `presenter`, `repository`） |
| 代码风格 | 使用 Android Studio 的格式化工具（Code > Reformat Code） |
| 代码复用 | 避免重复代码，合理封装工具类或组件 |

---

## 五、参考文档

- [Google Android 官方开发指南](https://developer.android.com/guide)
- [Android 开发者命名规范指南](https://developer.android.com/guide/topics/resources/available-resources)

---

如果你是团队开发，建议统一制定一份 **编码规范文档** 并在项目中使用 **Linter 工具**（如 `ktlint`、`checkstyle`）来强制执行命名规范。

需要我帮你生成一个 Android 项目命名规范模板吗？

Android 命名规范 （提高代码可以读性）

Android 命名规范（提高代码可以读性）