Flutter开发总结（一）代码规范

一、命名

1、驼峰命名法

大驼峰
使用场景：类、类型、枚举等，例：

Class UserModel {
}

enum Style {
}

小驼峰
使用场景：变量、常量、实例化对象等，例:

var item;
bool isUser;
const userName;
final userInfo;  
List photoList；
HttpRequest httpRequest = new HttpRequest ( );

2、英文小写

使用场景: 文件夹名，例：

widgets//相关控件文件放在此目录下；
model//相关模型文件
resourse//资源数据文件
utils//工具类文件

3、英文小写+下划线

使用场景：库、源文件、文件名，例：

import ‘package:image_picker/image_picker.dart’;
image_picker.dart
home_page.dart//主页面文件名
button_widget.dart//按钮控件文件名

4、英文大写+下划线

使用场景: 配置文件中的关键字key，例：

static const USER_NAME_KEY
static const BASE_URL

5、不使用前缀字母

Dart可以告诉你声明的类型、范围、可变性等，例：

//推荐 
defaultTimeout

//不推荐 
kDefaultTimeout

二、排序

1、引入库

在引入其他库之前先引入所需要的Dart库

import ‘dart:async’;

import ‘packet:test/test.dart’;

2、引入顺序

Dart SDK内的库
Flutter内的库
第三方库
自己的库
相对路径引用

注意每个部分使用空行分隔，例如：

import ‘dart:async’;

import ‘packet:flutter/material.dart;

import ‘packet:third_party/third_party.dart;

import ‘packet:my_packet/my.dart;
import ‘packet:my_packet/my.dart;

import ‘../model/my_model.dart’;

三、注释

1、双斜线

使用场景：基本上所有的变量、实例和函数方法，例：

double longitude;//经度
String name;//名称

//登录请求
loginRequest() {
}

2、Doc注释

使用三斜线 /// 文档注释来记录成员和类型，例：

不含参

///删除
void delete (){
}

含参，第一个句子之后添加一个空行，分成段落：

///删除方法
///
///相关描述...
void delete(String path){
}

四、其它

1、变量

Dart中，未显式初始化的变量或字段自动被初始化为null，不需要多余赋值null。例：

//推荐 
int userId;

//不推荐 
int userId = null；

2、添加下划线代表私有

私有变量、私有方法等，函数示例：

//public
void printName(String name ){
  print(“name = $name”);
}

//private
void _printName(String name ){
  print(“_name = $name”);
}

3、网络请求中的Map集合参数应该尽量以冒号:对齐

  Response response = await dio.post(path, 
                               data:{"key":"value",
                                     "key":"value",
                                     "key":"value",
                                     "key":"value"});

4、不要使用new关键字

Dart2使new关键字可选，例：

//推荐
Widget build(BuildContext context) {
  return Row(
    children: [
      RaisedButton(
        child: Text('Increment'),
      ),
      Text('Click!'),
    ],
  );
}

//不推荐
Widget build(BuildContext context) {
  return new Row(
    children: [
      new RaisedButton(
        child: new Text('Increment'),
      ),
      new Text('Click!'),
    ],
  );
}

5、不要使用.length查看集合是否为空

.length只是为了查看集合中是否包含任何内容，它的速度可能会非常慢。可以使用.isEmpty和.isNotEmpty，例：

//推荐
if (lunchBox.isEmpty) return 'so hungry...';
if (words.isNotEmpty) return words.join(' ');

//不推荐
if (lunchBox.length == 0) return 'so hungry...';
if (!words.isEmpty) return words.join(' ');

五、参考

官方文档 Effective Dart
Style
Documentation
Usage
Design

最后编辑于：2019.06.19 10:01:10