layuiAdmin pro v1.x 【单页版】开发者文档

文档更新时间：2019-3-26 22:28:09

layuiAdmin pro （单页版）是完全基于 layui 架构而成的后台管理模板系统，可以更轻松地实现前后端分离，它是 mvc 的简化版，全面接管 视图 和 页面路由，并可自主完成数据渲染，服务端通常只负责数据接口，而前端只需专注视图和事件交互，所有的页面动作都是在一个宿主页面中完成，因此这赋予了 layuiAdmin 单页面应用开发的能力。

题外

• 该文档适用于 layuiAdmin 专业版（单页面），阅读之前请务必确认是否与你使用的版本对应。
• 熟练掌握 layuiAdmin 的前提是熟练掌握 layui，因此除了本篇文档， layui 的文档 也是必不可少的存在。

快速上手

部署

1. 解压文件后，将 layuiAdmin 完整放置在任意目录
2. 通过本地 web 服务器去访问 ./start/index.html 即可运行 Demo

由于 layuiAdmin 可采用前后端分离开发模式，因此你无需将其放置在你的服务端 MVC 框架中，你只需要给 layuiAdmin 主入口页面（我们也称之为：宿主页面）进行访问解析，它即可全权完成自身路由的跳转和视图的呈现，而数据层则完全通过服务端提供的异步接口来完成。

目录说明

• src/
  layuiAdmin 源代码，通常用于开发环境（如本地），推荐你在本地开发时，将 ./start/index.html 中的 layui.css 和 layui.js 的引入路径由 dist 改为 src 目录。
  • src/controller/：存放 JS 业务模块，即对视图进行事件等交互性处理
  • src/lib/：layuiAdmin 的核心模块，一般不推荐修改
  • src/style/：存放样式，其中 admin.css是核心样式
  • src/views/：存放视图文件。其中 layout.html 是整个框架结构的承载，一般不推荐做大量改动。
  • src/config.js：layuiAdmin 的全局配置文件，可随意修改。
  • src/index.js：layuiAdmin 的入口模块，一般不推荐修改
• dist/
  通过 gulp 将 layuiAdmin src 目录的源代码进行构建后生成的目录（即：将 JS 和 CSS 文件进行了压缩等处理），通常用于线上环境。关于 gulp 的使用，下文也有介绍。
• start/
  存放 layuiAdmin 的入口页面、模拟接口数据、layui

宿主页面

你所看到的 start/index.html 是我们提供好的宿主页面，它是整个单页面的承载，所有的界面都是在这一个页面中完成跳转和渲染的。事实上，宿主页面可以放在任何地方，但是要注意修改里面的

路由跳转

通过上文的路由规则，你已经大致清楚了 layuiAdmin 路由的基本原理和解析方法。那么如何完成路由的跳转呢？

1. 在视图文件的 HTML 代码中，通过对任意元素设定 lay-href="/user/set/uid=123/type=1" ，好处是：任意元素都可以触发跳转。缺点是：只能在浏览器当前选项卡完成跳转（注意：不是 layuiAdmin 的选项卡）
2. 直接对 a 标签设定 href，如： text 。好处是：你可以通过设定 target="_blank" 来打开一个浏览器新选项卡。缺点是：只能设置 a 标签，且前面必须加 /#/
3. 在 JS 代码中，还可通过 location.hash = '/user/set'; 来跳转。前面无需加 #，它会自动追加。

路由结尾

在路由结尾部分出现的 / 与不出现，是两个完全不同的路由。比如下面这个：

1. user/set
   读取的视图文件是：.views/user/set.html
2. user/set/
   读取的视图文件是：./views/user/set/index.html （TIPS：这里的 index.html 即是目录下的默认主视图，下文会有讲解）

因此一定要注意结尾处的 /，避免视图读取错误。

视图

这或许是你应用 layuiAdmin 时的主要焦点，在开发过程中，你的大部分精力都可能会聚焦在这里。它取代了服务端 MVC 架构中的 view 层，使得应用开发变得更具扩展性。因此如果你采用 layuiAdmin 的 SPA（单页应用）模式，请务必要抛弃服务端渲染视图的思想，让页面的控制权限重新回归到前端吧！

views 目录存放的正是视图文件，你可以在该目录添加任意的新目录和新文件，通过对应的路由即可访问。

注意：如果是单页面模式，视图文件通常是一段 HTML 碎片，而不能是一个完整的 html 代码结构。

视图与路由的关系

每一个视图文件，都对应一个路由。其中 index.html 是默认文件（你也可以通过 config.js 去重新定义）。视图文件的所在目录决定了路由的访问地址，如：

视图路径	对应的路由地址
./views/user/index.html	/user/
./views/user.html	/user
./views/user/set/index.html	/user/set/
./views/user/set.html	/user/set
./views/user/set/base.html	/user/set/base

通过上述的表格列举的对应关系，可以总结出：

• 当视图文件是 index.html，那么路由地址就是它的上级目录（相对 views），以 / 结尾
• 当视图文件不是 index.html，那么路由地址就是它的上级目录+视图文件名，不以 / 结尾

值得注意的是：路由路径并非最多只能三级，它可以无限极。但对应的视图也必须存放在相应的层级目录下

视图中加载 JS 模块

在视图文件中，除了写 HTML，也可以写 JavaScript 代码。如：

Hello layuiAdmin

如果该视图对应的 JS 代码量太大，我们更推荐你在 controller 目录下新增一个业务模块，并在视图中直接 layui.use 去加载该模块。下面以控制台主页 index.html 为例：

html区域

当视图被渲染后，layui.factory 返回的函数也会被执行，从而保证在不重复加载 JS 模块文件的前提下，保证脚本能重复执行。

动态模板

layuiAdmin 的视图是一个“动静结合”的载体，除了常规的静态模板，你当然还可以在视图中存放动态模板，因此它可谓是焦点中的焦点。

定义模板

在视图文件中，通过下述规则定义模板：

下面是一个简单的例子：

在不对动态模板设定数据接口地址的情况下，它能读取到全局对象。但更多时候，一个动态模板应该是对应一个接口地址，如下所示：

模板中的 d 对应的是你接口返回的 json 转化后的一维对象，如：

{
  "code": 0
  ,"data": {
    "username": "贤心"
    ,"sex": "男"
  }
}

那么，上述动态模板最终输出的结果就是：

我叫：贤心
公的

模板基础属性

动态模板支持以下基础属性

• lay-url
  用于绑定模板的数据接口地址，支持动态模板解析，如：

• lay-type
  用于设定模板的接口请求类型（默认：get），如：

• lay-data
  用于定义接口请求的参数，其值是一个 JavaScript object 对象，同样支持动态模板解析，如：

• lay-headers
  用户定义接口请求的 Request Headers 参数，用法与 lay-data 的完全类似，支持动态模板解析。
• lay-done
  接口请求完毕并完成视图渲染的回调脚本，里面支持写任意的 JavaScript 语句。事实上它是一个封闭的函数作用域，通过给 Function 实例返回的函数传递一个参数 d，用于得到接口返回的数据：

很多时候，你在动态模板中可能会放入一些类似于 layui 的 form 元素，而有些控件需要执行 form.render() 才会显示，这时，你可以对 lay-done 赋值一个全局函数，如：

TIPS：

• 如果模板渲染完毕需要处理过多的交互，我们强烈推荐你采用上述的方式定义一个全局函数赋值给 lay-done，会极大地减少维护成本。
• 无需担心该全局函数的冲突问题，该函数是一次性的。其它页面即便声明了一个同样的函数，也只是用于新的视图，丝毫不会对之前的视图造成任何影响。
• layui.data.done 中的 done 可以随意命名，但需与 lay-done 的赋值对应上。

模板语法

动态模板基于 layui 的 laytpl 模块，详细语法可见：
http://www.layui.com/doc/modules/laytpl.html#syntax

登录与接口鉴权

由于 layuiAdmin 接管了视图层，所以不必避免可能会与服务端分开部署，这时你有必要了解一下 layuiAdmin 默认提供的：从 登录 到 接口鉴权，再到 注销 的整个流程。

登录拦截器

进入登入页面登入成功后，会在 localStorage 的本地表中写入一个字段。如： access_token （名称可以在 config.js 自定义）。拦截器判断没有 access_token 时，则会跳转到登入页。尽管可以通过伪造一个假的 access_token 绕过视图层的拦截，但在请求接口时，会自动带上 access_token，服务端应再次做一层校验。

流程

1. 打开 config.js ，将 interceptor 参数设置为 true（该参数为 1.0.0-beta6 开始新增）。那么，当其未检查到 access_token 值时，会强制跳转到登录页面，以获取 access_token。
2. 打开登录对应的视图文件 views/user/login.html，在代码最下面，你将看到一段已经写好的代码，你需要的是将接口地址改为服务端的真实接口，并返回 access_token值。
3. layuiAdmin 会将服务端返回的 access_token 值进行本地存储，这时你会发现 layuiAdmin 不再强制跳转到登录页面。并在后面每次请求服务端接口时，都会自动在参数和 Request Headers 中带上 access_token，以便服务端进行鉴权。
4. 若鉴权成功，顺利返回数据；若鉴权失败，服务端的 code 应返回 1001（可在 config.js 自定义） ， layuiAdmin 将会自动清空本地无效 token 并跳转到登入页。
5. 退出登录：重新打开 controller/common.js，搜索 logout，配上注销接口即可。

如果是在其它场景请求的接口，如：table.render()，那么你需要获取本地存储的 token 赋值给接口参数，如下：

//设置全局 table 实例的 token（这样一来，所有 table 实例均会有效）
table.set({
  headers: { //通过 request 头传递
    access_token: layui.data('layuiAdmin').access_token
  }
  ,where: { //通过参数传递
    access_token: layui.data('layuiAdmin').access_token
  }
});

 
//设置单个 table 实例的 token
table.render({
  elem: '#xxxx'
  ,url: 'url'
  ,where: {
    access_token: layui.data('layuiAdmin').access_token
  }
  //,headers: {}
});

事实上，layuiAdmin 的所有 Ajax 请求都是采用 admin.req(options)，它会自动传递 access_token，因此推荐你在 JS 执行 Ajax 请求时直接使用它。其中参数 options 和 $.ajax(options) 的参数完全一样。

接口鉴权

我们推荐服务端遵循 JWT（JSON Web Token） 标准进行鉴权。对 JWT 不甚了解的同学，可以去搜索一些相关资料，会极大地增加应用的可扩展性。当然，你也可以直接采用传统的 cookie / session 机制。

基础方法

• config 模块

你可以在任何地方通过 layui.setter 得到 config.js 中的配置信息

• admin 模块

var admin = layui.admin;

• admin.req(options)
  Ajax 请求，用法同 $.ajax(options)，只是该方法会进行错误处理和 token 的自动传递
• admin.screen()
  获取屏幕类型，根据当前屏幕大小，返回 0 - 3 的值
  0: 低于768px的屏幕
  1：768px到992px之间的屏幕
  2：992px到1200px之间的屏幕
  3：高于1200px的屏幕
• admin.exit()
  清除本地 token，并跳转到登入页
• admin.sideFlexible(status)
  侧边伸缩。status 为 null：收缩；status为 “spread”：展开
• admin.on(eventName, callback)
  事件监听，下文会有讲解
• admin.popup(options)
  弹出一个 layuiAdmin 主题风格的 layer 层，参数 options 跟 layer.open(options) 完全相同
• admin.popupRight(options)
  在屏幕右侧呼出一个面板层。options 同上。

admin.popupRight({
  id: 'LAY-popup-right-new1' //定义唯一ID，防止重复弹出
  ,success: function(){
    //将 views 目录下的某视图文件内容渲染给该面板
    layui.view(this.id).render('视图文件所在路径');
  }
});

• admin.resize(callback)
  窗口 resize 事件处理，我们推荐你使用该方法取代 jQuery 的 resize 事件，以避免多页面标签下可能存在的冲突。
• admin.fullScreen()
  全屏
• admin.exitScreen()
  退出全屏
• admin.events
  • admin.events.refresh()
    刷新当前右侧区域
  • admin.events.closeThisTabs()
    关闭当前标签页
  • admin.events.closeOtherTabs()
    关闭其它标签页
  • admin.events.closeAllTabs()
    关闭全部标签页

• view 模块

var view = layui.view;

• view(id)
  获取指定容器，并返回一些视图渲染的方法，如：

//渲染视图，viewPath 即为视图路径
view('id').render(viewPath).then(function(){
    //视图文件请求完毕，视图内容渲染前的回调
}).done(function(){
   //视图文件请求完毕和内容渲染完毕的回调
}); 

//直接向容器插入 html，tpl 为 模板字符；data 是传入的数据。该方法会自动完成动态模板解析
view('id').send(tpl, data); 

另外，render 方法支持动态传参，以用于视图内容接受。如：

admin.popup({
  id: 'LAY-popup-test1'
  ,success: function(){
    view(this.id).render('视图文件所在路径', {
       id: 123 //这里的 id 值你可以在一些事件中动态获取（如 table 模块的编辑）
    });
  }
});

那么，在视图文件中，你可以在动态模板中通过 {{ d.params.xxx }} 得到传入的参数，如：

而如果是在 JS 语句中去获取模板传递过来的变量，可以借助动态模板的 lay-done 属性去实现，如：

然后在 JS 语句中通过执行动态模板 lay-done 中对应的方法得到对应的参数值：

注意：上述实现需保证 layuiAdmin 为 1.2.0+`

总之，驾驭好 view().render().done(callback) 对您的项目开发至关重要。

ID唯一性

如果你开启了标签页功能，请务必注意 ID 的冲突，尤其是在你自己绑定事件的情况。ID 的命令可以遵循以下规则来规避冲突：

LAY-路由-任意名

以消息中心页面为例，假设它的路由为：/app/message/，那么 ID 应该命名为：

删除

实用组件

Hover 提示层

通过对元素设置 lay-tips="提示内容" 来开启一个 hover 提示，如：

其中 lay-offset 用于定于水平偏移距离（单位px），以调整箭头让其对准元素

事件监听

• hash
  监听路由地址改变

// 下述中的 xxx 可随意定义，不可与已经定义的 hash 事件同名，否则会覆盖上一事件
admin.on('hash(xxx)', function(router){
  console.log(router); //得到路由信息
});

• side
  监听侧边伸缩

// 下述中的 xxx 可随意定义，不可与已经定义的 side 事件同名，否则会覆盖上一事件
admin.on('side(xxx)', function(obj){
  console.log(obj.status); //得到伸缩状态：spread 为展开状态，其它值为收缩状态
});

兼容性

layuiAdmin 使用到了 layui 的栅格系统，而栅格则是基于浏览器的媒体查询。ie8、9不支持。
所以要在宿主页面（如 start/index.html ）加上下面这段保证兼容：

缓存问题

由于单页面版本的视图文件和静态资源模块都是动态加载的，所以可能存在浏览器的本地缓存问题，事实上我们也考虑到这个，因此，为了避免改动后的文件未及时生效，你只需在入口页面（默认为start/index.html）中，找到 layui.config ，修改其 version 的值即可。

我们推荐你分场景来更新缓存：

• 场景一：如果项目是在本地开发。你可以设置 version 为动态毫秒数，如：

version: new Date().getTime() //这样你每次刷新页面，都会更新一次缓存

---

• 场景二：如果项目是在线上运行。建议你手工更新 version，如：

version: '1.0.0' //每次发布项目时，跟着改动下该属性值即可更新静态资源的缓存

升级事项

从官网更新资源包后，除了 src 和 dist 目录需要注意一下，其它目录和文件均可覆盖，下面以 src 为例（dist 由于是 src 构建后生成的目录，所以本质是和 src 一样的）
src 目录下可以直接覆盖的有：

• src/lib/
• src/style/
• src/index.js

需要灵活调配的有：

• src/controller/
• src/views/
• src/config.js
  如果没有改动默认配置，事实上 config.js 也可以覆盖升级

开发过程中，建议同时运行两个 layuiAdmin 。一个是已经实际运用的，一个是 layuiAdmin 本身的 Demo。以便从 Demo 中获取参考和提取示例。

源码构建

当你在 src 目录完成开发后，你可通过 gulp 对 src 源码进行自动化构建，以生成用于线上环境的 dist 目录。并在入口页面中的 layui.config 的 base 参数指向 dist。

在资源包中根目录下看到的 gulpfile.js 是 layuiAdmin 写好的任务脚本，package.json 是任务配置文件，你只需按照以下步骤：

1. step1：确保你的电脑已经安装好了 Node.js，如果未安装，可去官网下载安装
2. step2: 命令行安装 gulp：npm install gulp -g
3. step3：切换到 layuiAdmin 项目根目录（即 gulpfile.js 所在目录），命令行安装任务所依赖的包：npm install

安装完成后，后续只需直接执行命令：gulp 即可完成 src 到 dist 目录的构建