README.md

    base app目前还处于内测阶段,内测QQ群号:869926521,欢迎大家加入!内测期间享受有疑问实时解答的福利。

    ps:文档处于完善过程中

    介绍

    base app,是一个云端一体的、集成了商用项目开发常见功能的项目模板。 如果说uniCloud admin是管理端项目的基础模板,那么base app则是用户端、尤其是移动端的基础模板。 在HBuilderX新建项目时选择base app项目模板,在这个模板基础之上快速填充自己的业务,即可很快完成一个应用。 地址:https://gitee.com/dcloud/base-app

    项目背景

    我们一直想出一个结合uni-app、uniCloud和openDB以及uni-id和uniCloud admin等,uni全家桶的项目模板; 为了照顾各类应用的开发者,我们取交集最终罗列了如下功能,发现这些就是除业务逻辑外的项目基本功能并把它命名为base app

    界面效果

    img{ box-shadow:0 0 2px #eeeeee; width:200px; margin:15px 5vw 0 0; float:left }

    base app集成的功能包括:

    1. 个人中心:登录注册(含用户名密码登录、手机号验证码登录、app一键登陆、微信登录、Apple登录、支付宝小程序登录)、修改密码、忘记密码、头像更换、昵称修改、积分查看、指纹绑定、退出
    2. 设置:App更新(整包升级、wgt升级、强制升级,后台搭配uniCloud admin的升级中心插件管理)、权限引导(app)、推送开关(app)、清除缓存(app)、用户协议、隐私协议(app)、问题与反馈、分享推荐、关于
    3. 启动引导:iOS初次启动被用户禁止网络权限后引导开启、Android弹出隐私协议后再申请权限
    4. 首页集成banner(后台搭配uniCloud admin的banner插件管理)、搜索、列表、详情、分享,均为云端一体。实际使用中将clientDB的表名更改为自己业务表名即可
    5. 首页采用nvue,fast编译模式,加快App端启动速度
    6. 内置联网失败的重试页面(不是错误弹框,页面有重试按钮)、更漂亮的分享菜单页面
    7. 内置拦截器:
      • 网络拦截
      • 页面路由拦截,需要登录才能用的,自动跳转到登陆页,登陆后自动继续
      • 权限拦截,定位、拍照、相册涉及隐私权限和设备是否开关
    8. h5版支持在页面顶部引导下载App

    base app将节省开发者大量的时间,让开发者集中精力在自己的特色业务上。 有了base app,再加上schema2code生成前端页面,一个简单应用就可以快速完成。 base app + uniCloud admin,应用开发从未如此简单快捷!

    base app提供了baseapp.config.js,可指定该应用是否强制登录才能进入首页,可配置选择登录注册方式以及不同方式的优先级等。

    module.exports = {
    	"h5": {
    		"url": "https://static-76ce2c5e-31c7-4d81-8fcf-ed1541ecbc6e.bspapp.com", //	前端网页托管的域名
    		 // 在h5端全局悬浮引导用户下载app的功能 更多自定义要求在/common/openApp.js中修改
    		"openApp": {
    			//点击悬浮下载栏后打开的网页链接
    			"openUrl": 'https://sj.qq.com/myapp/detail.htm?apkName=com.tencent.android.qqdownloader&info=6646FD239A6EBA9E2DEE5DFC7E18D867',
    			//左侧显示的应用名称
    			"appname": 'base-app',
    			//应用的图标
    			"logo": './static/logo.png',
    		}
    	},
    	"mp": {
    		"weixin": {
    			//微信小程序原始id,微信小程序分享时
    			"id": "gh_33446d7f7a26"
    		}
    	},
    	"router": {
    		//配置需要路由拦截的页面地址,在打开这些页面之前会自动检查(不联网)uni_id_token的值是否存在/过期等
    		"needLogin": [
    			"/pages/ucenter/userinfo/userinfo",
    			"/uni_modules/uni-news-favorite/pages/uni-news-favorite/list",
    			"/pages/ucenter/userinfo/uploadCutImageToUnicloud"
    		],
    		"login": ["smsCode","uniVerify", "username", "weixin", "apple"],
    		/* 
    			根据数组的第0项,决定登陆方式的第一优先级。
    			未列举到的,或设备环境不支持的选项,将被隐藏。
    			如果你需要在不同平台有不同的配置,直接用条件编译即可
    		*/
    	},
    	//关于应用
    	"about": {
    		//应用名称
    		"appName": "base-app",
    		//应用logo
    		"logo": "/static/logo.png",
    		//公司名称
    		"company": "数字天堂(北京)网络技术有限公司",
    		//口号
    		"slogan": "为开发而生",
    		//政策协议
    		"agreements": [{
    				"title": "用户服务协议", //协议名称
    				"url": "https://ask.dcloud.net.cn/protocol.html" //对应的网络链接
    			},
    			{
    				"title": "隐私政策",
    				"url": "https://ask.dcloud.net.cn/protocol.html"
    			}
    		],
    		//应用的链接,用于分享到第三方平台和生成关于我们页的二维码
    		"download": "https://m3w.cn/uniapp"
    	},
    	//用于打开应用市场评分界面
    	"marketId":{
    		"ios":"id1417078253",
    		"android":"123456"
    	}
    }

    应用配置

    目录结构

    base-app
    ├─uniCloud-aliyun	
    │	├─cloudfunctions 云函数目录
    │	|	├─common 公共模块
    │	│	|	├─uni-config-center		baseapp的服务端配置中心,项目所有云函数的配置在这里填写
    │	│	|	|	├─index.js			config-center入口文件
    │	│	|	|	└─uni-id			uni-id模块配置目录
    │	│	|	|		├─config.json	uni-id对应的配置数据
    │	│	|	|		└─file.cert		uni-id依赖的配置文件,假如你使用微信发红包功能,需要的证书文件就是放到这里
    │	|	|	└───uni-id				uni-id用户体系 详情
    │	|	├─uni-analyse-searchhot		云端一体搜索模板依赖的云函数 详情
    │	|	└─user-center				用户中心云函数,实现用户注册、修改密码、发送验证码、快捷登录(微信、短信、账户、一键登录)
    │	└──database						云数据目录
    │		├─db_init.json				db_init.json初始化数据库文件,其中不再包含schema 详情
    │		├─opendb-app-versions.schema.json		数据表xxx的DB Schema 详情
    │		├─opendb-banner.schema.json	        	数据表xxx的DB Schema 详情
    │		├─opendb-feedback.schema.json	        数据表xxx的DB Schema 详情
    │		├─opendb-news-articles.schema.json	    数据表xxx的DB Schema 详情
    │		├─opendb-news-categories.schema.json	数据表xxx的DB Schema 详情
    │		├─opendb-news-comments.schema.json		数据表xxx的DB Schema 详情
    │		├─opendb-news-favorite.schema.json		数据表xxx的DB Schema 详情
    │		├─opendb-search-hot.schema.json	        数据表xxx的DB Schema 详情
    │		├─opendb-search-log.schema.json	        数据表xxx的DB Schema 详情
    │		├─opendb-verify-codes.schema.json		数据表xxx的DB Schema 详情
    │		├─read-news-log.schema.json	        	数据表xxx的DB Schema 详情
    │		├─uni-id-log.schema.json	        	数据表xxx的DB Schema 详情
    │		├─uni-id-scores.schema.json	        	数据表xxx的DB Schema 详情
    │		└─uni-id-users.schema.json	        	数据表xxx的DB Schema 详情
    ├─pages										业务页面文件存放的目录
    │	├─common						
    │	│	└─webview							webview目录
    │	│		└─webview.vue					webview页面	用于实现跨端的web页面浏览
    │	├─grid
    │	│	└─grid.vue	 						带宫格和banner的示例页面
    │	├─list
    │	│	├─list.vue	 						新闻列表
    │	│	├─search
    │	│	│	└─search						云端一体搜索插件
    │	│	└─detail.vue						新闻详情
    │	├─ucenter
    │	│	├─about								关于我们
    │	│	│	└─about
    │	│	├─login-page						登陆模块
    │	|	|	├─common						登陆模块公共库
    │	│	│	│	├─login-page.css			公共样式库
    │	│	│	│	├─login-page.mixin.js		公共mixin
    │	│	│	│	└─loginSuccess.js			公共登陆成功后操作
    │	|	|	├─index							短信验证码登陆,手机号码输入页面
    │	|	|	├─phone-code					短信验证码登陆,验证码输入页面
    │	|	|	├─pwd-login						账户密码登陆
    │	|	|	├─pwd-retrieve					密码重置
    │	│	│	└─register						注册账户模块
    │	│	│		├─validator.js
    │	│	│		└─register.vue
    │	│	├─read-news-log						新闻阅读记录
    │	│	│	└─read-news-log
    │	│	├─settings						
    │	│	│	├─dc-push
    │	│	│	│	└─push.js					push权限操作SDK
    │	│	│	└─settings.vue					app设置
    │	│	├─userinfo							用户个人信息
    │	│	│	├─bind-mobile
    │	│	│	│	└─bind-mobile.vue			绑定手机号码
    │	│	│	├─limeClipper					图片裁剪插件,来源[limeClipper](https://ext.dcloud.net.cn/plugin?id=3594) @作者: 陌上华年
    │	│	│	│	├─images
    │	│	│	│	│	├─photo.svg
    │	│	│	│	│	└─rotate.svg
    │	│	│	│	├─index.css
    │	│	│	│	├─limeClipper.vue
    │	│	│	│	├─README.md
    │	│	│	│	└─utils.js
    │	│	│	├─main.js
    │	│	│	├─uploadCutImageToUnicloud.vue	引用limeClipper的图片裁剪模块,为了方便二开可能会出现兼容`vue`与`nvue`,所以做成了`页面`而不是`组件`
    │	│	│	└─userinfo.vue
    │	|	└─ucenter.vue						用户中心
    │	|
    ├─static	 						存放应用引用的本地静态资源(如图片、视频等)的目录,注意:静态资源只能存放于此
    ├─uni_modules						存放[uni_module](/uni_modules)规范的插件。
    ├─main.js							Vue初始化入口文件
    ├─App.vue							应用配置,用来配置App全局样式以及监听 应用生命周期
    ├─baseconfig						baseapp的前端的配置文件,项目所有模块的配置在这里填写。详见该文件的代码注释。
    ├─manifest.json	 					配置应用名称、appid、logo、版本等打包信息,详见
    └─pages.json						配置页面路由、导航条、选项卡等页面类信息,详见
    

    完整的uni-app目录结构详情

    按功能模块

    • 登陆模块
      • manifest.json App模块配置 --> OAuth(登录鉴权)--> 勾选并配置你所需要的模块
      • 登陆方式的优先级和登陆项(支持多平台条件编译)详情配置文件:baseconfigrouter -> login
      • 服务端配置详情:/uni_modules/uni-config-center/uniCloud/cloudfunctions/common/uni-config-center/uni-id/config.json
      • 更多uni-config-center的介绍 详情
    • 分享模块
      • manifest.json App模块配置 --> Share(分享)--> 勾选并配置你所需要的模块
      • 分享功能配置参数,随着应用的业务场景决定,在各场景调用的时候配置。参考base app的/pages/list/detail.vuemethods -> shareClick
      • 更多uni-share的介绍 详情
    • 升级中心相关
      • manifest.json 基础配置 --> 应用版本名称 和 应用版本号
      • 更多uni-upgrade-center的介绍 详情

    应用启动时序介绍

    文件路径: App.vue

    	import initApp from '@/common/appInit.js';
    	export default {
    		onLaunch: function() {
    			initApp();
    		}
    	}
    1. onLaunch还执行了initApp()包含以下操作
      1. 读取baseapp.config并挂载到globalData的config下
      2. 读取应用版本号,并存到globalData下。
      3. 检查是否有可更新的应用版本。
      4. 网络的变化与toast方式提醒
      5. 使用拦截器 实现了,
      • 强制登陆路由拦截。
      • 摄像头/相册权限,引导跳到设置界面
    2. onLaunch还执行了:
      1. 全局监听clientDB的err事件,
        • 判断是否为token过期失效等需要重新登陆的问题。自动跳转到登陆页面
        • 检测本地的token是否有效(存在且并未过期)否则跳转到登陆页面
      2. 预登陆一键登录功能

    快速体验部署流程

    1. 开通uniCloud

    • 开通uniCloud:本项目是云端一体的,它的云端代码需要部署在uniCloud云服务空间里,需要开通uniCloud。在https://unicloud.dcloud.net.cn/登录,按云厂商要求进行实名认证。
    • 在uniCloud认证通过后,创建一个服务空间给本项目使用。选择阿里云或腾讯云均可。参考
    • 使用HBuilderX 3.1以上版本(最好是最新版),把本项目导入到HBuilderX中,在项目根目录uniCloud上点右键菜单,关联服务空间 -> 选择之前创建的服务空间

    2. 关联项目与云服务空间

    img.cloud{ box-shadow:0 0 2px #eeeeee; width:400px; margin:15px 5vw 0 0; float:left } #### 3. 真机运行 注意:真机运行需要制作自定义基座,制作后选择运行到自定义基座.

    FAQ:常见问题

    1. 提示“公共模块uni-id缺少配置信息”解决方案:在cloudfunctions右键‘上传所有云函数、公共模块及actions’之后,需要在cloudfunctions--》common--》uni-config-center 目录单独上传一次,右键‘上传公共模块’。
    2. 本项目代码可以商用,无需为DCloud付费。但不能把本项目的代码改造用于非uni-app和uniCloud的技术体系。即,不能将后台改成php、java等其他后台,这将违反使用许可协议。

    第三方插件(感谢插件作者,排名不分前后):

    1. 图片裁剪 limeClipper @作者: 陌上华年
    2. 二维码生成 Sansnn-uQRCode @作者: 3snn

    项目简介

    云端一体应用快速开发基本项目模版

    发行版本

    当前项目没有发行版本

    贡献者 5

    DCloud_JSON @LanJingLingJu
    study夏羽 @weixin_44781626
    DCloud-WZF @wangzhenyu66
    雪洛 @u013082782
    hbcui1984 @hbcui1984

    开发语言

    • Vue 46.6 %
    • JavaScript 46.2 %
    • HTML 5.6 %
    • SCSS 1.1 %
    • CSS 0.6 %