注:视频会有滞后问题,入门为主。最新的完整功能请看以下文档
uni-starter是一个集成了大量商用项目常见功能的,云端一体应用快速开发基本项目模版。
APP有很多通用的功能,比如登录注册、头像、设置、banner、... uni-starter将这些功能都已经集成好。
直接在hbuilderx
新建项目选择uni-starter
模板,即可在此基础上快速开发自己的特色业务。
有了uni-starter
,再加上schema2code
生成前端页面,一个简单应用就可以快速完成。
如果说uniCloud admin是管理端项目的基本项目模版,那么uni-starter则是用户端、尤其是移动端的基础项目模板。
uni-starter
+ uniCloud admin
提供了用户端和管理端的基本项目模版,应用开发从未如此简单快捷!
token
若无效就自动跳转到登录页uniCloud
:本项目是云端一体的,它的云端代码需要部署在uniCloud云服务空间里,需要开通uniCloud。在https://unicloud.dcloud.net.cn/登录,按云厂商要求进行实名认证。登陆类型 | 描述 |
---|---|
smsCode | 验证码登录 |
univerify | 读取手机SIM卡一键登录 |
username | 账号密码登录 |
weixin | 微信登录 |
apple | 苹果登录 |
配置文件:项目根目录/uni-starter.config.js
{
"router":{
"login":["username","smsCode"]
}
}
如上示例配置为:["username","smsCode"]
表示启用:验证码登录、账号密码登录。
同理配置为:["weixin","username","smsCode"]
则表示启用:微信登录、验证码登录、账号密码登录。
总结:需要几项列举几项即可。
在uni-starter框架中执行uni.navigateTo({url: "/pages/ucenter/login-page/index/index"})
,会根据配置跳转到相应的登陆页面。如果配置内容为:["username","smsCode"]
会自动切换到"配置的第0项,也就是username
类型的登录方式对应的页面”,即账户登录
方式页面,路径:/pages/ucenter/login-page/pwd-login/pwd-login
这里支持用条件编译因此你可以配置在不同平台下拥有的登录方式。 如下配置,即表示仅在APP端启用“短信验证码登陆”
"login": [
"username","univerify","weixin","apple"
// #ifdef APP-PLUS
"smsCode",
// #endif
]
登陆方式有如上5种,虽然你希望有几种登陆方式就在配置中列举几种。但是有的登陆方式可能因为设备环境问题而不被支持; 比如你正确地配置了微信登陆,而用户的手机并没有安装微信,这样微信登陆功能就无法使用。 并且如果出现这种情况你的app会被iOS的App Store拒绝上架。 所以在这里,我们的生效策略在检测:你是否有列举到某个配置项为前提的情况下,增加了检测当前环境是否支持,如果不支持会自动隐藏。
在应用模块:manifest.json
App模块配置 --> OAuth(登录鉴权)--> 勾选并配置你所需要的模块
/uniCloud-aliyun/cloudfunctions/uni-id-cf/index.js
搜索 const templateId = '11753'
替换为自己申请的模板iduni-starter服务端使用uni-config-center统一管理这些配置,
文件路径/uni_modules/uni-config-center/uniCloud/cloudfunctions/common/uni-config-center/uni-id/config.json
详情下文目录结构 和uni-id配置说明
有些页面,限允许已经登陆后用户才访问。
常规的做法是打开这类页面之前,检查(前端校验)uni_id_token的值是否有效,如果无效会自动跳转到登陆页面。
而这样的页面有很多,入口也不少。面向过程的写法会产生大量的代码冗余,且不易维护。
而uni-starter基于拦截器(uni.addInterceptor
),提供了仅需简单配置即可实现的路由拦截功能。
支持两种模式(二选一)
列举需要强制登陆的页面完整路径(支持正则)
列举不需要强制登陆即可访问的页面完整路径(支持正则)
配置文件:项目根目录/uni-starter.config.js
"router": {
"needLogin" : [
{pattern:/^\/pages\/list.*/}, //支持正则表达式
"/uni_modules/uni-news-favorite/pages/uni-news-favorite/list",
"/uni_modules/uni-feedback/pages/uni-feedback/add"
],
/*
请注意上下,黑名单(needLogin)、白名单(visitor)两种配置模式二选一不可同时使用
*/
"visitor" : [
"/",//注意入口页必须直接写 "/"
{"pattern":/^\/pages\/list.*/}, //支持正则表达式
{"pattern":/^\/pages\/ucenter\/login-page.*/},
"/pages/common/webview/webview",
"/pages/grid/grid",
"/pages/ucenter/ucenter",
"/pages/ucenter/guestbook/guestbook",
"/pages/ucenter/about/about",
"/pages/ucenter/settings/settings"
]
}
传统的路由管理方式是对uni-app框架路由写法的二次封装,自定义的写法不支持ide的代码提示,且不优雅。
另外不同插件作者封装不同的路由管理方式,这样做出来的插件与用户的项目结合时,路由写法不统一的差异需要去磨平。
为此uni-starter
基于uni.addInterceptor
(拦截器)实现路由管理。
/pages/ucenter/login-page/index/index
设置为首页,否则由拦截器实现的路由管理将生效。点击下载App
把h5端用户引流到APP端,是一个非常实用的功能。相对于h5,APP端有更高的用户留存和更好的产品体验。
uni-starter集成了这个功能,你只需直接在项目根目录/uni-starter.config.js
的"h5"->"openApp"中配置相关内容,即可开启全局悬浮的下载引导。
这也是一个演示开发者如何在h5端做全局悬浮块的例子。你也可以在/common/openApp.js
中修改他的样式等代码等,注意他只支持原生js语法。
一个可覆盖原生层分享模块
manifest.json
App模块配置 --> Share --> 勾选并配置你所需要的模块/pages/list/detail.vue
的methods -> shareClick
uni-share
的介绍 详情
为了解决开发者维护多个 App 升级繁琐,重复逻辑过多,管理不便的问题,升级中心uni-upgrade-center
应运而生。
提供了简单、易用、统一的 App 管理、App 版本管理、安装包发布管理,升级检测更新管理。
uni-upgrade-center
Admin管理后台和uni-upgrade-center - Admin
前台检测更新。uni-upgrade-center
的介绍 详情
uni-upgrade-center - Admin
的介绍 详情
manifest.json
App模块配置 --> Fingerprint
指纹识别manifest.json
App模块配置 --> push
消息推送根据工业和信息化部关于开展APP侵害用户权益专项整治要求,App提交到应用市场必须满足以下条件:
配置弹出“隐私协议和政策”打开项目的manifest.json文件,切换到“源码视图”项
在manifest.json
-> app-plus
-> privacy
节点下添加 prompt节点
"privacy" : {
"prompt" : "template",
"template" : {
"title" : "服务协议和隐私政策",
"message" : " 请你务必审慎阅读、充分理解“服务协议”和“隐私政策”各条款,包括但不限于:为了更好的向你提供服务,我们需要收集你的设备标识、操作日志等信息用于分析、优化应用性能。<br/> 你可阅读<a href=\"https://ask.dcloud.net.cn/protocol.html\">《服务协议》</a>和<a href=\"https://ask.dcloud.net.cn/protocol.html\">《隐私政策》</a>了解详细信息。如果你同意,请点击下面按钮开始接受我们的服务。",
"buttonAccept" : "同意",
"buttonRefuse" : "暂不同意"
}
}
更多Android平台隐私与政策提示框配置方法,详情
manifest.json
生效相关的配置均需要提交云打包后生效 if(Debug){
console.log(e);
uni.showModal({
content: JSON.stringify(e),
showCancel: false
});
}
比如你希望在打开用户中心等页面之前,都检查一下该用户是否登陆,否则就重定向到登陆页面。使用拦截器你可以用以下写法在应用入口定义全局生效:
//定义各个页面,这里为了演示uni-starter框架是把该定义写在全局配置uni-starter.config.js中
let needLogin = ["/pages/ucenter/userinfo/userinfo", ... ]
uni.addInterceptor("navigateTo", {
invoke(e) { // 调用前拦截
//获取用户的token
const token = uni.getStorageSync('uni_id_token')
//获取当前页面路径(即url去掉"?"和"?"后的参数)
const url = e.url.split('?')[0]
//判断要打开的页面是否需要验证登陆
if (needLogin.includes(url) && token == '') {
uni.showToast({
title: '该页面需要登录才能访问,请先登录',
icon: 'none'
})
uni.navigateTo({
url: "/pages/ucenter/login-page/index/index"
})
return false
}
},
fail(err) { // 失败回调拦截
console.log(err);
},
})
uni.navigateTo
还有uni.redirectTo
,uni.reLaunch
,uni.switchTab
; const {"router": {needLogin,login} } = uniStarterConfig //需要登录的页面
let list = ["navigateTo", "redirectTo", "reLaunch", "switchTab"];
list.forEach(item => { //用遍历的方式分别为,uni.navigateTo,uni.redirectTo,uni.reLaunch,uni.switchTab这4个路由方法添加拦截器
uni.addInterceptor(item, {
invoke(e) { // 调用前拦截
//获取用户的token
const token = uni.getStorageSync('uni_id_token')
//获取当前页面路径(即url去掉"?"和"?"后的参数)
const url = e.url.split('?')[0]
//判断要打开的页面是否需要验证登陆
if (needLogin.includes(url) && token == '') {
uni.showToast({
title: '该页面需要登录才能访问,请先登录',
icon: 'none'
})
uni.navigateTo({
url: "/pages/ucenter/login-page/index/index"
})
return false
}
//控制登录优先级
if (url == '/pages/ucenter/login-page/index/index') {
//一键登录(univerify)、账号(username)、验证码登录(短信smsCode)
if (login[0] == 'univerify') {
if(e.url == url) { e.url += '?' } //添加参数之前判断是否带了`?`号如果没有就补上,因为当开发场景本身有参数的情况下是已经带了`?`号
e.url += "univerify_first=true"
} else if (login[0] == 'username') {
e.url = "/pages/ucenter/login-page/pwd-login/pwd-login"
}
}
return true
},
fail(err) { // 失败回调拦截
console.log(err);
},
})
})
项目升级
uni-starter遵循uni-app的插件模块化规范,即:uni_modules 。他是个项目类型的插件。在项目的根目录下有一个符合uni_modules规范的package.json文件,在这个文件右键-从插件市场更新即可更新该插件。
插件升级
非项目类型的uni_modules插件,是项目根目录下的uni_modules目录下。以插件ID为插件文件夹命名,在该目录右键也会看到“从插件市场更新”选项,点击即可更新该插件。
uni-starter支持多语言国际化。默认开启,可以在`uni-starter.config.js`->`i18n`->`enable`中配置
如果你启用了多语言国际化需要先阅读:[uni-app多语言国际化](https://uniapp.dcloud.io/collocation/i18n?id=%e6%a1%86%e6%9e%b6%e5%86%85%e7%bd%ae%e7%bb%84%e4%bb%b6%e5%92%8capi%e5%9b%bd%e9%99%85%e5%8c%96)
文件路径: App.vue
import initApp from '@/common/appInit.js';
export default {
onLaunch: function() {
initApp();
}
}
onLaunch生命周期执行了
选择图片
所需要的权限。当调用uni.chooseImage
时检测到无权限自动开启引导。并不是在每次调用接口时处理这类问题,你可以参考该例子做更多该类场景的处理。uni-starter也会持续完善uni-starter提供了uni-starter.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": 'uni-starter',
//应用的图标
"logo": './static/logo.png',
}
},
"mp": {
"weixin": {
//微信小程序原始id,微信小程序分享时
"id": "gh_132465798"
}
},
"router": {
//配置需要路由拦截的页面地址,在打开这些页面之前会自动检查(无需联网)uni_id_token的值,如果token无效就自动跳转到登录页
"needLogin": [
"/pages/ucenter/userinfo/userinfo",
"/uni_modules/uni-news-favorite/pages/uni-news-favorite/list",
],
"login": ["smsCode","univerify", "username", "weixin", "apple"],
/*
这里会根据数组的第0项,决定登录方式的第一优先级是哪种登录方式。
所有你希望拥有的登录方式这里都需要一一列举,未列举到的或设备环境不支持的登录方式将被隐藏。
如果你需要在不同平台有不同的配置,直接用条件编译即可。
*/
},
//关于应用
"about": {
//应用名称
"appName": "uni-starter",
//应用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"
},
//配置多语言国际化。i18n为英文单词 internationalization的首末字符i和n,18为中间的字符数 是“国际化”的简称
"i18n":{
"enable":false //默认启用,国际化。如果你不想使用国际化相关功能,请改为false
}
}
uni-starter ├─uniCloud-aliyun │ ├─cloudfunctions 云函数目录 │ | ├─common 公共模块 │ │ | ├─uni-config-center uni-starter的服务端配置中心,项目所有云函数的配置在这里填写 详情 │ │ | | ├─index.js config-center入口文件 │ │ | | └─uni-id uni-id模块配置目录 │ │ | | ├─config.json uni-id对应的配置数据:微信登录、一键登录、短信验证码登录等key都在这里填写详情 │ │ | | └─file.cert uni-id依赖的配置文件,假如你使用微信发红包功能,需要的证书文件就是放到这里 │ | | └───uni-id uni-id用户体系 详情 │ | ├─uni-analyse-searchhot 云端一体搜索模板依赖的云函数 详情 │ | └─uni-id-cf 用户中心云函数,实现用户注册、修改密码、发送验证码、快捷登录(微信、短信、账户、一键登录) │ └──database 云数据目录 │ ├─db_init.json db_init.json初始化数据库文件,其中不再包含schema 详情 │ ├─opendb-app-versions.schema.json 应用版本,表结构文件 │ ├─opendb-banner.schema.json 横幅数据表,表结构文件 │ ├─opendb-feedback.schema.json 意见反馈表,表结构文件 │ ├─opendb-news-articles.schema.json 新闻文章表,表结构文件 │ ├─opendb-news-categories.schema.json 新闻分类表,表结构文件 │ ├─opendb-news-comments.schema.json 新闻评论表,表结构文件 │ ├─opendb-news-favorite.schema.json 新闻收藏表,表结构文件 │ ├─opendb-search-hot.schema.json 热门搜索表,表结构文件 │ ├─opendb-search-log.schema.json 搜索记录表,表结构文件 │ ├─opendb-verify-codes.schema.json 验证码表,表结构文件 │ ├─uni-id-log.schema.json 登录日志表,表结构文件 │ ├─uni-id-scores.schema.json 用户积分表,表结构文件 │ └─uni-id-users.schema.json 用户表,表结构文件 ├─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 │ │ │ ├─cropImage.vue 引用limeClipper的图片裁剪模块,为了方便二开可能会出现兼容`vue`与`nvue`,所以做成了`页面`而不是`组件` │ │ │ └─userinfo.vue │ | └─ucenter.vue 用户中心 │ | ├─static 存放应用引用的本地静态资源(如图片、视频等)的目录,注意:静态资源只能存放于此 ├─uni_modules 存放[uni_module](/uni_modules)规范的插件。 ├─uni_modules_tools uni_modules插件上传辅助脚本 详情。 ├─main.js Vue初始化入口文件 ├─App.vue 应用配置,用来配置App全局样式以及监听 应用生命周期 ├─uni-starter.config uni-starter的前端的配置文件,项目所有模块的配置在这里填写。详见该文件的代码注释。 ├─manifest.json 配置应用名称、appid、logo、版本等打包信息,详见 └─pages.json 配置页面路由、导航条、选项卡等页面类信息,详见
完整的uni-app目录结构详情
uniIDHasRole
演示页面:/pages/grid/grid
API文档详情:
/pages/ucenter/settings/settings
API文档详情:
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。