JavaScript 钉钉企业内部H5微应用开发流程与代码结构

钉钉企业内部H5微应用开发概述

1.开放平台创建H5应用

钉钉开放平台（https://open-dev.dingtalk.com/）,进入“应用开发”->企业内部开发H5微应用->创建应用,并填写基本信息和配置开发信息

2、JSAPI鉴权服务端API开发

• 通过appKey 和 appSecret 获取调用接口凭证AccessToken(https://oapi.dingtalk.com/gettoken?appkey=appKey&appsecret=appSecret)

• 通过AccessToken 获取用于JSAPI的临时票据Ticket(https://oapi.dingtalk.com/get_jsapi_ticket?access_token=ACCESS_TOKEN)

• ticket(JSAPI的临时票据)，nonceStr(随机串),timeStamp(时间戳)，url(当前网页的URL，不包含#及其后面部分)计算签名信息

计算签名参数（Java/SDK）

/*
     *ticket(JSAPI的临时票据)，nonceStr(随机串),timeStamp(时间戳)，url(当前网页的URL，不包含#及其后面部分)计算签名信息
     * */
    public static function sign($ticket, $nonceStr, $timeStamp, $url)
    {
        $plain = 'jsapi_ticket=' . $ticket .
            '&noncestr=' . $nonceStr .
            '&timestamp=' . $timeStamp .
            '&url=' . $url;
        return sha1($plain);
    }

• 通过AccessToken 获取用于JSAPI的临时票据Ticket(说明：由于会牵涉到多个企业，企业的appKey 和 appSecret的一些信息都是写在JSON配置文件中，前端传企业ID到服务端，服务端就会从JSON配置文件中获取企业信息)

/*
     * 根据企业ID corpid 返回 JSAPI 鉴权配置信息
     * */
    public static function getConfig($corpid)
    {
        $_config = self::getApiConfig($corpid);
        $appkey = $_config["AppKey"];
        $appsecret = $_config["AppSecret"];
        $agentid = $_config["AgentId"];
        $nonceStr = 'flywong';
        $timeStamp = time();
        //$url = self::getCurrentUrl();
        $url = $_config["AppUrl"];
        
        $accessToken = self::getAccessToken($appkey,$appsecret);
        $ticket = self::getTicket($accessToken);
        $signature = self::sign($ticket, $nonceStr, $timeStamp, $url);
        
        $config = array(
            'agentId' => $agentid,
            'corpId' => $corpid,
            'timeStamp' => $timeStamp,
            'nonceStr' => $nonceStr,
            'signature' => $signature,
            'url' => $url,
            'type'=>0
        );
        return json_encode($config, JSON_UNESCAPED_SLASHES);
    }

• 根据企业ID corpid 从api_config.json配置文件中找到 企业对应的信息，并返回企业应用开发信息

public static function getApiConfig($corpid)
    {
         $json_string = file_get_contents(__DIR__ .'/../api_config.json');   //从文件中读取数据到PHP变量
         $arrs = json_decode($json_string, true); 
         foreach($arrs as $key => $value)
         {
             if($value["CorpId"] == $corpid)
             {
                 return $value;
             }
         }
    }

3、JSAPI鉴权前端API开发

// 异步获取dd.config
  async getDDConfig({commit, state},callback) {
    // 发送异步ajax请求
    const result = await reqDDConfig(state.CorpId)
    // 提交一个mutation
    const ddconfig = result
    ddconfig.jsApiList= state.jsApiList 
　　dd.config(ddconfig); 
　　commit(RECEIVE_DDCONFIG, {ddconfig}) 

　　// 数据更新了, 通知一下组件 
　　callback && callback() 
}
let that = this;
      //获取 JSAPI 鉴权配置信息
      that.$store.dispatch('getDDConfig', () => {//
        that.$nextTick(() => {// 数据ddconfig state 更新后执行
          that.$store.dispatch('getUserinfo')//获取登入用户信息
          that.$store.dispatch('getGeolocation')//获取地图定位信息
        })
      })
/* 状态管理*/
export default {
  CorpId:'dingb0bd5c5a3ba53e1231232378f',//企业ID
  ddconfig:{},//钉钉签权配置信息
  jsApiList:[
    'runtime.info',
    'biz.contact.choose',
    'device.notification.confirm',
    'device.notification.alert',
    'device.notification.prompt',
    'biz.ding.post',
    'biz.util.openLink',
    'device.geolocation.get',
    'biz.util.scanCard'
  ],//需要签权的JSAPI
  userinfo:{}, //用户信息
  geolocation:{} //地图定位信息
}

4、H5微应用的免登

“免登”是指用户进入应用后，无需输入钉钉用户名和密码，应用程序可自动获取当前用户身份，进而登录系统的流程。

• 1、前端去获取微应用免登授权码，然后把授权码发送到服务端api得到当前用户信息

// 异步获取userinfo
  getUserinfo({commit, state}) {
    dd.runtime.permission.requestAuthCode({
      corpId: state.CorpId, // 企业id
      onSuccess: async function (info) {
        let code = info.code // 通过该免登授权码可以获取用户身份
        // 发送异步ajax请求
        const result = await reqUserinfo(code,state.CorpId)
        // 提交一个mutation
        const userinfo = result
        commit(RECEIVE_USERINFO, {userinfo})
      }
    })
  }

• 2、服务端API获取用户信息

/*
     * 通过免登授权码code和access_token获取用户的userid
     * */
    public static function getUserInfo($accessToken, $code)
    {
        $response = \util\Http::get("/user/getuserinfo",array("access_token" => $accessToken, "code" => $code));
        $userinfo = json_decode(json_encode($response),true);
        $userid = $userinfo["userid"];
        return self::getuser($accessToken,$userid);
    }
    /*
     * 通过access_token 和 userid 获取用户详情
     * */
    private static function getuser($accessToken,$userid)
    {
        $response = \util\Http::get("/user/get",array("access_token" => $accessToken, "userid" => $userid));
        return json_encode($response);
    }

6.代码结构

• 1.整个页面的框架结构

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <meta content="width=device-width,initial-scale=1.0,maximum-scale=1.0,user-scalable=no" name="viewport">
    <meta content="yes" name="apple-mobile-web-app-capable">
    <meta content="black" name="apple-mobile-web-app-status-bar-style">
    <meta content="yes" name="apple-mobile-web-app-capable">
    <meta content="black" name="apple-mobile-web-app-status-bar-style">
    <meta content="telephone=no" name="format-detection">
    <meta content="email=no" name="format-detection">
　　<link rel="stylesheet" href="css/*.css" type="text/css">
<title>主结构</title>
</head>
<body>
    页面内容页面内容
　　<script type="text/javascript" src="js/*.js"></script>
</body>
</html>

• 2.meta 详解

• viewport设置为屏幕的宽度，禁用缩放
• apple-mobile-web-app-capable：当网站添加到主屏幕快速启动方式，可隐藏地址栏，仅针对ios的safari
• apple-mobile-web-app-status-bar-style：将网站添加到主屏幕快速启动方式，仅针对ios的safari顶端状态条的样式
• telephone=no：禁用自动识别手机号
• email=no：禁用自动识别邮箱