主题
loginPage - 登录页面扩展
为系统提供一个新的登录页面模版，登录页面扩展可以在系统设置-登录页面设置中被选用，只有被选用后，登录页面扩展产生的登录页面才会真正生效。
登录页面扩展的机制就是提供一个模版给系统设置-登录页面设置功能，并根据设置页面中用户的设置动态的生产一个HTML文件，最后将HTML存入元数据系统项目的指定位置（/sysdata/public/login/index.html）后登录页面就正式生效了。
扩展文件结构
ts
/
├──package.json //定义扩展的配置信息
├──main.ts //扩展的主体代码，提供动态生产HTML文件内容的逻辑
├──thumbnail.png //缩略图
├──thumbnail-phone.png //系统设置中，选择登录页面模版时当用户切换到手机时使用
├──index.html //必须存在，可以使用响应式布局兼容多种设备
├──index.less //样式写这里
├──index.ts //默认不存在
└──images/ //图片存放目录package.json
json
"contributes": {
"loginPage": {
/**
* 是否支持手机
*/
"supportPhone":boolean,
"properties":{
}
}
}index.html
index.html就是一个常规的html页面，开发者可以按需要自由进行编写，需要遵守一些约定，如需要存在一些约定了id或class的元素。
系统自动注入到登录页面的内容
系统初始化一个登录页面时会先在后端加载 index.html内容并解析，然后自动注入一些内容到html页面后再发送给前端浏览器，注入的内容包括：
html
<title>xxx</title>
<meta itemprop="name" content="xxxx">
<meta name="description" itemprop="description" content="xxxx">
<meta name="succ-context-path" content="">
...
<link rel="stylesheet" href="/dist/sys/sys-all.css" type="text/css">
<link rel="stylesheet" href="/dist/commons/icons.css" type="text/css">
...
<script type="text/javascript" src="/dist/sys/sys-all.js"></script>
<script type="text/javascript" src="/dist/i18n/zh_CN.js"></script>
<script type="text/javascript" src="/dist/security/login.js"></script>
<script sz-template="html">
requirejs(['sys/sys'], function(sys) {
sys.ready('security/login').then(function(m){
m.initLoginPage();
})});
</script>登录页面的典型DOM结构
开发者在开发自己的登录页面时可以不用自己在html中写上面自动注入的内容，一个典型的登录页面的结构如下：
html
<!DOCTYPE html>
<head>
<meta charset="utf-8">
<style type="text/css">
...
</style>
</head>
<body>
<div id="page" class="login-body loading"> <!-- page 页面顶层dom -->
<div class="version"></div> <!-- 显示产品版本信息的元素 -->
<div class="logo"></div>
<div class="login-container"> <!-- 登录框 -->
<div class="type-switcher">...</div> <!-- 登录内容切换器 -->
<div class="login-content"> <!-- 登录内容 -->
<div class="password-content">...</div> <!-- 账号密码输入框 -->
<div class="qrcode-container"> <!-- 二维码框， 只有系统中配置对应的二维码登录方式的时候才会即时创建 -->
<div class="qrcode-title"></div>
<div class="qrcode-content">
<div class="qrcode qrcode-wechat"></div>
<div class="qrcode qrcode-wework"></div>
</div>
<div class="qrcode-btns"> <!-- 只有有多种二维码登录方式的时候才会创建 -->
<span class="btn-wechat qtcode-btn"></span>
<span class="btn-wework qtcode-btn"></span>
</div>
</div>
</div>
</div>
</div>
</body>
</html>登录页面前端初始化流程
前端浏览器渲染登录页面时会进行如下步骤：
- 先使用ajax请求获得系统登录页面的一些基本配置信息，例如是否启用了记住密码功能
- 根据系统设置信息自动进行一些页面内部的元素的class的调整（具体见下文）
- 如果存在全局js变量
LoginPageCustomJS，那么会自动调用它内部定义的一些约定方法（具体见下文）
页面上用户进行了某些操作或系统某些选项打开后page（即id为page的页面元素）的class会自动的进行修改，方便开发者调整页面样式：
loading当前页面正在加载，加载完成后此class会被删除multiple-login当前页面支持多种登录方式，比如用户启用了微信扫码登录password当前显示的是用户名密码登录方式qrcode当前切换到了二维码扫码登录方式qrcode-wework当前切换到了企业微信扫码登录方式qrcode-wechat当前切换到了微信扫码登录方式rememberme系统启用了记住密码功能captcha当前需要输入验证码
登录页面前端事件接口
如果存在全局js变量LoginPageCustomJS，那么会自动调用它内部定义的一些约定方法:
点击查看
ts
/**
* 登录和权限判断相关的前端二次开发脚本接口。
*/
export interface ILoginPageCustomJS {
/**
* 登录页面（与登录对话框不同，登录页面是占满整个浏览器页面的，等会对话框时在页面进行操作时提示用户需要登录时显示
* 的一个对话框）初始化后调用，方便二次开发时对登录页面进行一些个性化处理。
*
* @param options 登录界面可能会用到的一些参数
* @param login 登录页面对象
* @returns 可返回空，如果返回的延迟对象，那么resolve后登录页面才显示。
*/
onDidLoginPageInit?(options: LoginPageConf, loginPage: LoginPage): Promise<any> | any;
/**
* 登录对话框（与登录页面不同，登录页面是占满整个浏览器页面的，登录对话框时在页面进行操作时提示用户需要登录时显示
* 的一个对话框）初始化后调用，方便二次开发时对登录对话框进行一些个性化处理。
*
* @param options 登录界面可能会用到的一些参数
* @param loginPage 登录对话框对象
* @returns 可返回空，如果返回的延迟对象，那么resolve后登录页面才显示。
*/
onDidLoginDialogInit?(options: LoginPageConf, loginDialog: LoginDialog): Promise<any> | any;
/**
* 点击登录按钮，提交登录请求前调用
*
* @param args.user userId
* @param args.password 密码
* @param args.remember 是否需要记住密码
* @param args.captchaId 验证码id
* @param args.captcha 输入的验证码
* @returns 明确返回false或者Promise<false> 表明终止提交登录请求
*/
onSendLoginRequest?(args: { user: string; password: string; remember?: string, captchaId?: string, catpcha?: string }): Promise<boolean> | boolean | any;
/**
* 完成登录请求之后调用
*
* @param result 登录请求响应结果
* @param comp 账号密码登录框对象 或者登录对话框对象
* @returns 明确返回false或者Promise<false>,表明终止默认请求响应处理
*/
onDidSendLoginRequest?(result: JSONObject, comp: LoginDialog | UserLoginPage): Promise<boolean> | boolean | any;
/**
* 当界面出现了需要登录的异常时调用（如匿名用户在访问了某些需要有权限才能访问的页面时），此调用会在默认的登录对话框弹出前
* 调用，开发者可以通过此函数实现个性化的提示逻辑。
*
* @param e 错误信息,
* @param e.properties.loginTime 需要登录的原因可能是因为系统限制了一个账号只能在一台机器上登录，如果当前登录的账号在其他机器上重新登录，就会将当前的登录挤掉，
* 这个参数就是为了告诉用户挤掉当前登录账号的登录操作时间。
* @param e.properties.loginIpAddress 挤掉当前登录账号的登录IP地址
* @returns 根据不同的返回结果会有不同的后续执行逻辑：
* 1. true或者undefined 继续执行默认的登录逻辑，弹出登录对话框
* 2. false 表示开发者已经自己处理了此异常，系统将不再弹出默认的登录对话框了，并直接reject之前用户发起的业务逻辑
* 3. 其他返回值表明开发者自己完成了登录，系统将继续完成用户所做的业务,
*/
onNeedLoginError?(e?: Error): Promise<boolean> | boolean | any;
/**
* 当界面出现了无权限的异常时调用（如用户访问了某些没有权限的页面，匿名用户不会出现此异常，匿名用户只会出现需要登录的异常），此调用
* 会在弹出系统默认的权限异常对话框前调用，方便开发者个性化提示信息。
*
* @param e 错误信息
* @returns 根据不同的返回结果会有不同的后续执行逻辑：
* 1. false 表示开发者已经自己处理了此异常，系统将不再弹出默认的提示框
* 2. true或其他值，系统将继续弹出默认提示狂
*/
onPermissionError?(e: Error,): Promise<boolean> | boolean | any;
/**
* 提交登录请求报错时候调用
*
* @param e 错误信息
* @param userLoginPage 账号密码登录框对象
* @returns 如果返回 false, 则结束登录请求操作
*/
onLoginError?(e: Error, userLoginPage: UserLoginPage | LoginDialog): Promise<boolean> | boolean | any;
}兼容移动设备
登录页面模版应该总是兼容移动设备，2个方法（推荐方法1）：
- 使用响应式布局，让
index.html同时支持多种设备 - 单独实现
index-phone.html和index-pad.html
注意，如果用户设置了登录页面的自定义js或css，那么移动端和PC端都将自动加载。
示例
下面是系统默认登录页面的html代码：
点击查看
