[内部]一步一步把Asp.Net MVC站点集成到综合平台4.0

背景介绍

  如果你的业务站点是基于Asp.Net MVC的,并且你想集成到综合平台4.0,
  让平台管理你的权限和登录,甚至是基础数据,那么你来对了。

随着Asp.Net WebForm技术的淘汰,现在很多站点都采用了微软MVC模式进行开发,综合平台4.0为了更好的支持该种站点的集成,也提供了相应的API和方法。

首先分析下两个实现模式的区别:

webform模式:httpmodule进行拦截请求,然后判断授权和认证
mvc模式:[过滤器]技术,拦截每个服务请求,进行相关授权认证

所以下文都将怎么基于【过滤器】进行相关的配置和说明。可以熟悉下
参考博文之过滤器.

准备环境

首先在集成前,需要准备下环境:

1、可以正常访问的平台,并且你有管理员权限
2、你的站点代码,并且站点可以发布到平台所在服务器
3、你的站点升级到asp.net MVC5版本
4、获取最新平台集成依赖程序集(见下图)

依赖dll.png

配置文件

为了便于演示,这里我用vs2015新增了一个Web站点(最简单的ASP.NET MVC),如下结构:

演示站点.png

当然,一口气把依赖平台的程序集全部添加到引用里面。

修改web.config 站点配置:

<configuration>
....省略部分配置...
  <configSections>
    <sectionGroup name="Supcon.IntegrationPlatform">
      <section name="Global" type="System.Configuration.SingleTagSectionHandler" />
    </sectionGroup>
  </configSections>
  <Supcon.IntegrationPlatform>
    <Global EnablePrivilegeValidation="true" 
            UseLibProxy="false" 
            UseLocalLib="False" 
            IsDebugMode="false" 
            Username="2017" 
            Password="123456" 
            Server="http://127.0.0.1:8181/MESIP" 
             AppID="testForMvc" />
  </Supcon.IntegrationPlatform>
....省略部分配置...
</configuration>

其中Global内节点解释:

1、EnablePrivilegeValidation,是否开启权限控制,如果设置为false,那么权限将不进行验证,这个功能一般是开发阶段用,默认请设置为true。

2、IsDebugMode,如果开启,那么将用底下的Username和Password进行模拟登录,这个功能一般是开发阶段用,默认请设置为false。

3、Server,集成平台的地址,一般人都知道吧。一般都是http://X.X.X.X:Y/MESIP。这里我把平台部署到了本地的8181端口。

4、AppID,当前应用在平台注册的子系统编号,后面会讲注册点

修改代码

配置登录验证过滤器,打开全局的Global.asax的后台代码,添加全局过滤器:

public class MvcApplication : System.Web.HttpApplication
{
 protected void Application_Start()
 {
   AreaRegistration.RegisterAllAreas();
   RouteConfig.RegisterRoutes(RouteTable.Routes);
   //全局过滤器-用于登录身份验证
  GlobalFilters.Filters.Add(new Supcon.UnifiedPlatform.Framework.Mvc.AuthenticationFilter());
  }
}

如上设置后,意味着全局的页面和服务都要进行登录验证。

如果有一些页面和服务不需要登录可以访问,那么在action上添加设置参数的过滤器[AuthenticationFilter(false)]。

测试站点内,我构建了一个HomeController,比如里面有个页面NotNeedLogin,不需要登录就可以访问的,配置如下:

        /// <summary>
        /// 无需登录即可访问
        /// </summary>
        /// <returns></returns>
        [AuthenticationFilter(false)]
        public ActionResult NotNeedLogin()
        {
            return View();
        }

讲完了身份验证,那么接着配置授权验证,比如有些页面【当然应该是大部分】,需要进行功能授权才能访问,那么在需要进行权限控制的页面action添加过滤器特殊过滤器 [AuthorizationModuleFilter],比如有个页面叫:NeedRightList,配置如下

        [AuthorizationModuleFilter]
        public ActionResult NeedRightList()
        {
            return View();
        }

为了演示按钮权限,页面添加脚本(如果无需按钮权限,不用添加):

<script type="text/javascript">
    
    var SitePage = {
        toolBarList: "@ViewBag.toolBarList",
        rightsTools: "@ViewBag.RightToolBarList",
        moduleId: "@ViewBag.ModuleId"
    }


</script>

除了页面,asp.net mvc 还有很多服务需要进行权限控制,为了区分和方便控制,我们也新增了一个服务权限过滤器,用于过滤权限 [AuthorizationFunctionFilter]。比如删除服务:

        /// <summary>
        /// 删除功能 需要权限的按钮功能
        /// </summary>
        /// <returns></returns>
        [AuthorizationFunctionFilter]
        public JsonResult DeleteServer()
        {
            return Json("Success");
        }

这里需要特别说明的是,过滤器AuthorizationFunctionFilter可是设置一个参数enforce:bool,其解释如下:

enforce:false:
非强制该服务进行权限验证, 即:如果该服务没用在权限管理里面注册,那么这个服务不会强制进行权限验证【也没法验证】。
enforce:true:
强制该服务进行权限验证,即:如果该服务没用在权限管理里面注册,那么视同该权限当前用户没用权限处理。

完整的HomeController代码:

namespace UpSimpleMvcDemo.Controllers
{
    public class HomeController:Controller
    {
        /// <summary>
        /// 无需登录即可访问
        /// </summary>
        /// <returns></returns>
        [AuthenticationFilter(false)]
        public ActionResult NotNeedLogin()
        {
            return View();
        }
        /// <summary>
        /// 登录即可访问
        /// </summary>
        /// <returns></returns>
        public ActionResult List()
        {
            return View();
        }
        /// <summary>
        /// 权限控制点菜单
        /// </summary>
        /// <returns></returns>
        [AuthorizationModuleFilter]
        public ActionResult NeedRightList()
        {
            return View();
        }
        /// <summary>
        /// 需要权限的服务
        /// </summary>
        /// <returns></returns>
        [AuthorizationFunctionFilter]
        public JsonResult NeedRigthServer()
        {
            return Json("Success",JsonRequestBehavior.AllowGet);
        }
        /// <summary>
        /// 删除功能 需要权限的按钮功能
        /// </summary>
        /// <returns></returns>
        [AuthorizationFunctionFilter]
        public JsonResult DeleteServer()
        {
            return Json("Success",JsonRequestBehavior.AllowGet);
        }

    }
}

注册功能

好了,站点的代码和配置修改已经结束,下面介绍下平台权限如何注册系统,和配置权限。

1、注册应用和菜单

当然首先将我们的站点部署到平台同站点IIS,比如说是我们部署了:http://localhost:8181/UpMvc

打开平台功能菜单:系统管理--集成设置-参数管理 ,添加站点参数:


站点参数.png

打开平台功能菜单:系统管理--基础数据--应用管理,新增子系统:Mvc集成

添加系统.png

备注:这里的编号就是我们在web.config里面注册的APPID的来源。

添加菜单和菜单内部的按钮服务:

菜单.png
功能和服务.png

新建角色:mvc角色,并且将角色分配给当前用户(该功能在:角色管理和业务授权,不在累述)。为了演示,我们设置了如下权限:

权限.png

当前用户有菜单:列表【权限】页面权限,并且还有删除、修改和新增按钮,但是其没有【服务测试】服务。



一切配置都结束了,现在通过菜单打开页面:列表【权限】,发现已经可以正常打开了,并且,你可以查看页面脚本,同时添加了按钮的id以供控制显示:


页面脚本.png

toolBarList:当前页面所有按钮ID,rightsTools:当前用户有权限的按钮ID。

接下去怎么控制按钮权限,就是各个业务系统自己的事情了,这里不再累述,不过如果你的系统是基于MES最新开发框架的,那么这一切你不需要关心,toolbar控件已经集成了按钮权限控制。


同时我们进行以下其他页面的测试:
1、无需登录就可访问的页面,新打开浏览器测试下:http://localhost:8181/UpMvc/Home/NotNeedLogin

无登录.png

2、需要登录才能访问的页面,新打开浏览器测试下:
http://localhost:8181/UpMvc/Home/List

登录才能访问的.png

3、需要登录且需要授权的服务和需要登录无需授权的服务:
为了演示效果,我们修改NeedRightList.cshtml页面

<script src="~/Scripts/jquery-1.10.2.min.js"></script>

<script type="text/javascript">

    var SitePage = {
        toolBarList: "@ViewBag.toolBarList",
        rightsTools: "@ViewBag.RightToolBarList",
        moduleId: "@ViewBag.ModuleId"
    }

    function GetSeverDeleteServer() {
        $.ajax({
            type: 'POST',
            dataType: "json",
            url: "@Url.Content("~/Home/DeleteServer")",
            success: function (ret) {
                alert(ret);
            }
        });
    }

    function GetSeverNeedRigthServer() {
        $.ajax({
            type: 'POST',
            dataType: "json",
            url: "@Url.Content("~/Home/NeedRigthServer")",
            success: function (ret) {
                alert(ret);
            },
            error: function (ret) {
                alert(ret.responseJSON.Msg);
            }
        });
    }

</script>



<h2>打开我,你已经有权限了</h2>

<a href="#" onclick="GetSeverDeleteServer();">已经授权的服务DeleteServer</a>
<br />
<a href="#" onclick="GetSeverNeedRigthServer();">为经授权的服务NeedRigthServer</a>

点击第一个连接:success
点击第二个连接:当前功能没有权限,无法访问!



最后共享下示例站点源码:
https://pan.baidu.com/s/1bpMygt5 密码:npmq

推荐阅读更多精彩内容