本專案已全部開源,歡迎Star&Fork。
專案包含啟動頁,引導頁,主題色,國際化,Bloc,RxDart。擁有較好的專案結構,比較規範的程式碼。App擁有精緻的UI介面,統一的互動,側滑退出,列表和Web介面均提供快速滾動至頂部功能。
作者初衷是為大家提供一個比較規範的Flutter專案示例。
有關專案最新動態,可以關注App內第一條Hot Item資訊。
App目錄結構
- |--lib
- |-- blocs (bloc相關)
- |-- common (常用類,例如常量Constant)
- |-- data (網路資料層)
- |-- db (資料庫)
- |-- event (事件類)
- |-- models (實體類)
- |-- res (資原始檔,string,colors,dimens,styles)
- |-- ui (介面相關page,dialog,widgets)
- |-- utils (工具類)
data網路資料層
- |--data
- |-- api (url欄位)
- |-- net (單例DioUtil)
- |-- protocol (請求與返回實體類)
- |-- repository (介面請求&解析)
api
class WanAndroidApi {
/// 首頁banner http://www.wanandroid.com/banner/json
static const String BANNER = "banner";
static const String USER_REGISTER = "user/register"; //註冊
static const String USER_LOGIN = "user/login"; //登入
static const String USER_LOGOUT = "user/logout"; //退出
// 拼接url
static String getPath({String path: '', int page, String resType: 'json'}) {
StringBuffer sb = new StringBuffer(path);
if (page != null) {
sb.write('/$page');
}
if (resType != null && resType.isNotEmpty) {
sb.write('/$resType');
}
return sb.toString();
}
}
複製程式碼
請求與返回實體類 protocol
class LoginReq {
String username;
String password;
LoginReq(this.username, this.password);
LoginReq.fromJson(Map<String, dynamic> json)
: username = json['username'],
password = json['password'];
Map<String, dynamic> toJson() => {
'username': username,
'password': password,
};
@override
String toString() {
StringBuffer sb = new StringBuffer('{');
sb.write("\"username\":\"$username\"");
sb.write(",\"password\":$password");
sb.write('}');
return sb.toString();
}
}
複製程式碼
介面請求&解析 repository
class WanRepository {
Future<List<BannerModel>> getBanner() async {
BaseResp<List> baseResp = await DioUtil().request<List>(
Method.get, WanAndroidApi.getPath(path: WanAndroidApi.BANNER));
List<BannerModel> bannerList;
if (baseResp.code != Constant.STATUS_SUCCESS) {
return new Future.error(baseResp.msg);
}
if (baseResp.data != null) {
bannerList = baseResp.data.map((value) {
return BannerModel.fromJson(value);
}).toList();
}
return bannerList;
}
}
複製程式碼
資原始檔 res
- |--res
- |-- colors.dart
- |-- dimens.dart
- |-- strings.dart
- |-- styles.dart
colors.dart
class Colours {
static const Color app_main = Color(0xFF666666);
static const Color text_dark = Color(0xFF333333);
static const Color text_normal = Color(0xFF666666);
static const Color text_gray = Color(0xFF999999);
}
複製程式碼
dimens.dart
class Dimens {
static const double font_sp12 = 12;
static const double font_sp14 = 14;
static const double font_sp16 = 16;
static const double gap_dp5 = 5;
static const double gap_dp10 = 10;
}
複製程式碼
strings.dart
class Ids {
static const String titleHome = 'title_home';
}
Map<String, Map<String, Map<String, String>>> localizedValues = {
'en': {
'US': {
Ids.titleHome: 'Home',
}
},
'zh': {
'CN': {
Ids.titleHome: '主頁',
},
'HK': {
Ids.titleHome: '主頁',
},
'TW': {
Ids.titleHome: '主頁',
}
}
};
複製程式碼
styles.dart
class TextStyles {
static TextStyle listTitle = TextStyle(
fontSize: Dimens.font_sp16,
color: Colours.text_dark,
fontWeight: FontWeight.bold,
);
static TextStyle listContent = TextStyle(
fontSize: Dimens.font_sp14,
color: Colours.text_normal,
);
static TextStyle listExtra = TextStyle(
fontSize: Dimens.font_sp12,
color: Colours.text_gray,
);
}
// 間隔
class Gaps {
// 水平間隔
static Widget hGap5 = new SizedBox(width: Dimens.gap_dp5);
static Widget hGap10 = new SizedBox(width: Dimens.gap_dp10);
// 垂直間隔
static Widget vGap5 = new SizedBox(height: Dimens.gap_dp5);
static Widget vGap10 = new SizedBox(height: Dimens.gap_dp10);
}
複製程式碼
Flutter 國際化相關
fluintl 是一個為應用提供國際化的庫,可快速整合實現應用多語言。該庫封裝了一個國際化支援類,通過提供統一方法getString(id)獲取字串。
// 在MyApp initState配置多語言資源
setLocalizedValues(localizedValues); //配置多語言資源
// 在MaterialApp指定localizationsDelegates和supportedLocales
MaterialApp(
home: MyHomePage(),
localizationsDelegates: [
GlobalMaterialLocalizations.delegate,
GlobalWidgetsLocalizations.delegate,
CustomLocalizations.delegate //設定本地化代理
],
supportedLocales: CustomLocalizations.supportedLocales,//設定支援本地化語言集合
);
// 字串獲取
IntlUtil.getString(context, Ids.titleHome);
CustomLocalizations.of(context).getString(StringIds.titleHome);
複製程式碼
Flutter 螢幕適配 ScreenUtil
方案一、不依賴context
步驟 1
//如果設計稿尺寸預設配置一致,無需該設定。 配置設計稿尺寸 預設 360.0 / 640.0 / 3.0
setDesignWHD(_designW,_designH,_designD);
步驟 2
// 在MainPageState build 呼叫MediaQuery.of(context)
class MainPageState extends State<MainPage> {
@override
Widget build(BuildContext context) {
// 在 MainPageState build 呼叫 MediaQuery.of(context)
MediaQuery.of(context);
return new Scaffold(
appBar: new AppBar(),
);
}
}
步驟 3
ScreenUtil.getInstance().screenWidth
ScreenUtil.getInstance().screenHeight
//螢幕適配相關
ScreenUtil.getInstance().getWidth(size); //返回根據螢幕寬適配後尺寸(單位 dp or pt)
ScreenUtil.getInstance().getHeight(size); //返回根據螢幕高適配後尺寸 (單位 dp or pt)
ScreenUtil.getInstance().getWidthPx(sizePx); //sizePx 單位px
ScreenUtil.getInstance().getHeightPx(sizePx); //sizePx 單位px
ScreenUtil.getInstance().getSp(fontSize); //返回根據螢幕寬適配後字型尺寸
複製程式碼
方案二、依賴context
//如果設計稿尺寸預設配置一致,無需該設定。 配置設計稿尺寸 預設 360.0 / 640.0 / 3.0
setDesignWHD(_designW,_designH,_designD);
ScreenUtil.getScreenW(context); //螢幕 寬
ScreenUtil.getScreenH(context); //螢幕 高
//螢幕適配相關
ScreenUtil.getScaleW(context, size); //返回根據螢幕寬適配後尺寸(單位 dp or pt)
ScreenUtil.getScaleH(context, size); //返回根據螢幕高適配後尺寸 (單位 dp or pt)
ScreenUtil.getScaleSp(context, size) ;//返回根據螢幕寬適配後字型尺寸
複製程式碼
Flutter 資料儲存 SpUtil
SpUtil : 單例"同步" SharedPreferences 工具類。 專案中為大家提供SpHelper,方便存取實體物件類。
// 儲存SplashModel實體物件
SplashModel model = new SplashModel();
SpHelper.putObject(Constant.KEY_SPLASH_MODEL, model);
// 獲取SplashModel實體物件
SplashModel model = SpHelper.getSplashModel();
class SpHelper {
// 儲存Obj,T 用於區分儲存型別
static void putObject<T>(String key, Object value) {
switch (T) {
case int:
SpUtil.putInt(key, value);
break;
case double:
SpUtil.putDouble(key, value);
break;
case bool:
SpUtil.putBool(key, value);
break;
case String:
SpUtil.putString(key, value);
break;
case List:
SpUtil.putStringList(key, value);
break;
default:
SpUtil.putString(key, value == null ? "" : json.encode(value));
break;
}
}
static SplashModel getSplashModel() {
String _splashModel = SpUtil.getString(Constant.KEY_SPLASH_MODEL);
if (ObjectUtil.isNotEmpty(_splashModel)) {
Map userMap = json.decode(_splashModel);
return SplashModel.fromJson(userMap);
}
return null;
}
}
複製程式碼