带有Upida/Jeneva的ASP.NET MVC单页应用程序（前端/AngularJS）

寒冰屋

于 2019-10-24 14:33:38 发布

阅读量259

点赞数

分类专栏：架构及框架 MVC web前端文章标签： Jeneva AngularJS ASP.NET MVC

原文链接：https://www.codeproject.com/Articles/686880/ASP-NET-MVC-Single-Page-App-with-Upida-Jeneva-Fron

版权

架构及框架同时被 3 个专栏收录

634 篇文章 16 订阅

订阅专栏

web前端

235 篇文章 4 订阅

订阅专栏

MVC

73 篇文章 3 订阅

订阅专栏

介绍

在上一篇文章中，我演示了如何使用WebAPI和Jeneva.Net创建基于JSON的Web后端。在本文中，我将展示一些有关如何使用Angular.js创建单个页面前端的基本技巧。如果您不熟悉AngularJS的基础知识，请访问此YouTube频道。

背景

假设我们已经有一个工作的后端，它包含两个控制器——一个MVC控制器提供HTML视图，另一个WebAPI控制器为我们提供方便的REST JSON API。

public class ClientController : System.Web.Mvc.Controller
{
    public ActionResult List()
    {
        return this.View();
    }
 
    public ActionResult Create()
    {
        return this.View();
    }
 
    public ActionResult Edit()
    {
        return this.View();
    }
}

public class ClientController : System.Web.Http.ApiController
{
    public IClientService ClientService { get; set; }

    public Client GetById(int id)
    {
        return this.ClientService.GetById(id);
    }

    public IList<client> GetAll()
    {
        return this.ClientService.GetAll();
    }

    public void Save(Client item)
    {
        this.ClientService.Save(item);
    }

    public void Update(Client item)
    {
        this.ClientService.Update(item);
    }

    [HttpPost]
    public void Delete(int id)
    {
        this.ClientService.Delete(id);
    }
}

两种控制器看起来都很简单且可行。请参考我以前的文章，以了解如何创建后端。我的目标是为这两个控制器创建前端。前端必须是单页浏览器应用程序（SPA）。许多人认为SPA不是一种有用的技术，因为它不会产生指向不同页面的链接，并且SPA需要您付出大量的努力，因此不值得。我将向您展示，使用AngularJS，您可以像创建多页应用程序一样简单地创建SPA，并且多页应用程序的所有好处都将保留在SPA中。

基本结构

每个单页应用程序（SPA）的最重要部分是其结构。我们将有3个视图：“客户端列表”，“创建客户端”和“编辑客户端”。这实际上意味着，我们将有三个AngularJS这些视图控制器——clientListController.js，clientCreateController.js和clientEditController.js。“vendor”文件夹包含所有第三方库。我们也有自定义过滤器。通常，这种结构还具有“指令 ”和“服务 ”文件夹，但是在这个简单的SPA中，我没有使用任何自定义指令和服务。

前端的基本部分是位于js文件夹根目录中的app.js文件。让我们分析其内容。

var myclients = myclients || {};
myclients.app = angular.module("myclients", ["ngRoute", "jenevamodule"]);
 
myclients.app.config(function ($routeProvider) {
    $routeProvider
        .when("/", {
            templateUrl: "client/list",
            controller: "clientListController"
        })
        .when("/client/list", {
            templateUrl: "client/list",
            controller: "clientListController"
        })
        .when("/client/create", {
            templateUrl: "client/create",
            controller: "clientCreateController"
        })
        .when("/client/edit/:id", {
            templateUrl: "client/edit",
            controller: "clientEditController"
        })
        .otherwise({
            templateUrl: "home/notfound"
        });
});
 
$jeneva.settings.baseUrl = "/api/";

在第一行中，我定义了应用程序的主名称空间。然后，使用AngularJS，创建主模块的实例。这是每个Angular应用程序的常见任务。并且此模块依赖于两个不同的模块：ngRoute 和jenevamodule，它们都是独立的可重复使用的angular模块。最有趣的部分是在中间部分。如您所见，我在这里定义了几个路由器。这实际上是任何前端的核心。简单地说——在这里，我告诉AngularJS-应该打开哪个js控制器和哪个视图，具体取决于浏览器中的URL。每时每刻，我的应用程序只有一个活动视图和控制器，这取决于在浏览器窗口中输入的URL。例如，如果我输入url：client/list，则client/list视图和clientListController将被主动加载。

app.js的最后一部分专用于Jeneva.Net。我使用它是因为它使我的应用程序更易于开发和支持。我告诉Jeneva，我的WebAPI控制器位于/api/子文件夹中。

JS控制器

现在，让我们看一下控制器。第一个是clientListController.js。

myclients.app.controller(
    "clientListController", ["$scope", "jeneva",
    function ($scope, jeneva) {
 
    $scope.clientRows = new Array();
 
    $scope.ClientRow = function (id) {
        this.id = id;
        this.name = null;
        this.lastname = null;
        this.age = null;
        this.logins = new Array();
    };
 
    $scope.loadClients = function() {
        jeneva.get("client/getall")
        .then(function (items) {
            angular.forEach(items, function (p, i) {
                var row = new $scope.ClientRow(p.id);
                row.name = p.name;
                row.lastname = p.lastname;
                row.age = p.age;
                angular.forEach(p.logins, function (q, j) {
                    row.logins.push(q.name);
                });
                $scope.clientRows.push(row);
            });
        });
    };

   $scope.onDelete = function (clientId) {
      jeneva.post("client/delete/" + clientId)
      .then(function () {
         $scope.loadClients();
      });
   };
 
    $scope.$on("$routeChangeSuccess", function () {
        jeneva.setScope($scope);
        $scope.loadClients();
    });
}]);

如您所见，我指的是在app.js文件的前两行中创建的myclients.app模块。我的控制器已命名为clientListController，并注入了2个变量：$scope和jeneva。在控制器主体中，我定义了数据库中的客户端列表$scope.clientRows，这是我的视图模型。该$scope.loadClients方法与后端进行交互，其jeneva使用服务来调用WebAPI控制器。我使用jeneva服务而不是直接使用angular（$http）调用的原因是——如果后端失败，并且我在视图中的正确位置（基于jvPath验证器和jvErrorkey指令）显示错误消息，jeneva会自动进行管理。当我的WebAPI返回客户列表，我将其填充到$scope.clientRows字段中。

我的控制器的最后一部分是最重要的。我将处理程序附加到该$routeChangeSuccess事件。每当此控制器处于活动状态时，即每次用户导航到“客户端列表”视图时，都会触发此事件。就我而言，触发此事件时，将调用$scope.loadClients方法，并从后端提取数据。

其他控制器大致相同。它们注入了$location变量，用于在AngularJS SPA中的视图之间导航。例如，clientCreateController.js：

myclients.app.controller(
    "clientCreateController",
    ["$scope", "$location", "jeneva", function ($scope, $location, jeneva) {
 
    $scope.name = null;
    $scope.lastname = null;
    $scope.age = null;
    $scope.loginRows = new Array();
 
    $scope.LoginRow = function () {
        this.name = null;
        this.password = null;
        this.enabled = false;
    };
 
    $scope.onRemoveLoginClick = function (item) {
        var index = $scope.loginRows.indexOf(item);
        $scope.loginRows.splice(index, 1);
    };
 
    $scope.onAddLoginClick = function () {
        var row = new $scope.LoginRow();
        $scope.loginRows.push(row);
    };
 
    $scope.onSave = function () {
        var data = {};
        data.name = $scope.name;
        data.lastname = $scope.lastname;
        data.age = $scope.age;
        data.logins = new Array();
        angular.forEach($scope.loginRows, function (p, i) {
            var item = {};
            item.name = p.name;
            item.password = p.password;
            item.enabled = p.enabled;
            data.logins.push(item);
        });
        jeneva.post("client/save", data)
        .then(function () {
            $location.path("client/list");
        });
    };
 
    $scope.$on("$routeChangeSuccess", function () {
        $scope.onAddLoginClick();
    });
}]);

看一下$scope.onSave方法。当用户单击“客户端创建”视图的“保存”按钮时，它将触发。它将所有用户输入的数据收集到一个大数据变量中，并使用jeneva服务将其作为JSON发送到WebAPI控制器。如果成功保存数据，则将调用$location.path()方法，并且用户将再次导航到“客户端列表”视图。如果后端失败或后端验证失败，则jeneva服务将处理此问题，并且所有验证问题将显示在视图中的正确位置，具体取决于jeneva指令（本文后面，您将看到Jeneva如何处理这些失败）。

clientEditController.js以同样的方式工作，你可以看到它的源代码。

HTML视图

如您所知，只有三个视图——客户端列表，创建客户端和编辑客户端。如果您不熟悉AngularJS，请参考此youtube频道。让我们看一下“列表”视图。

<a href="#/client/create">NEW CLIENT</a>
<h2>Clients</h2>
<span class="error" jv-error-key></span>
<hr />
<table border="1" style="width: 50%;">
<thead>
    <tr class="head">
        <th>ID</th>
        <th>NAME</th>
        <th>LASTNAME</th>
        <th>AGE</th>
        <th>LOGINS</th>
        <th></th>
    </tr>
</thead>
<tbody>
    <tr ng-repeat="row in clientRows">
        <td ng-bind="row.id"></td>
        <td ng-bind="row.name"></td>
        <td ng-bind="row.lastname"></td>
        <td ng-bind="row.age"></td>
        <td>
            <div ng-repeat="login in row.logins">
                <span ng-bind="login"></span><br />
            </div>
        </td>
        <td>
            <a ng-href="#/client/edit/{{row.id}}">Edit</a>
        </td>
        <td>
            <input type="button" ng-click="onDelete(row.id)" value="Delete" />
        </td>
    </tr>
</tbody>
</table>

对于那些熟悉AngularJS的人来说，理解这段代码非常简单。该视图与clientListController.js绑定在一起。基本上，此代码引用控制器代码中的$scope.clientRows字段，并将客户端列表显示为HTML表。

这里最有趣的是链接。看一下链接：

<a href="#/client/create">NEW CLIENT</a>

如您所见，URL以＃号开头，这实际上意味着，如果您单击链接，浏览器将不会重新加载页面。相反，AngularJS将捕获此事件，并根据在app.js文件中注册的路由切换活动视图和活动控制器。例如，如果您单击NEW CLIENT链接，AngularJS将用Create Client视图的内容替换当前视图的内容，并且活动控制器将变为——clientCreateController.js。

另一个有趣的是在视图顶部：

<span class="error" jv-error-key></span>

这由Jeneva的jv-error-key 指令控制span。实际上，这意味着当故障响应从后端服务器到达浏览器时，带有空键的错误消息将显示在span内。有时，您必须使用无密钥（或无路径）错误消息，例如“Unexpected failure”消息或一些更具体的消息——“You cannot delete this client”（或者您可以为某些错误消息提供静态密钥）。关于无密钥（或静态密钥）失败消息的最好的事情是，它们不需要将任何JSON数据发布到服务器。除了无密钥消息外，您还可以随时定义自定义密钥，例如，您可以定义“server_error“密钥（路径），然后可以使用此密钥将失败注册到验证上下文，然后可以使用jv-error-key 伪指令在表单上的任何位置显示该失败消息。在此示例中，我将无密钥消息用于未处理的异常，并且在每个表单的顶部显示它们。我还使用无密钥消息通知用户由于某种原因用户无法删除客户端（请参阅ClientService中的删除客户端）。

现在看一下“编辑客户端”链接：

<a ng-href="#/client/edit/{{row.id}}">Edit</a>

如您所见，此链接导航到“编辑客户端”视图，其中还包含客户端的ID。editClientController必须知道如何从链接中提取此ID。看一下app.js文件，如何定义“编辑客户端”视图的路由。

.when("/client/edit/:id", {
    templateUrl: "client/edit",
    controller: "clientEditController"
})

AngularJS路由机制能够处理url参数。并且clientEditController可以使用$routeParams服务访问它们。$routeParams必须以与其他服务相同的方式将服务注入到控制器中。请查看源代码以获取更多详细信息。

现在，让我们看一下“创建客户端”视图。

<a href="#/client/list">ALL CLIENTS</a>|
<h2>New Client</h2>
<span class="error" jv-error-key></span>
<span class="error" jv-error-key="logins"></span>
<hr />
<table ng-form name="form">
<tr>
    <td>Name</td>
    <td>
        <input name="name" type="text" ng-model="name" jv-path="name" />
        <span class="error" ng-if="form.name.$error.jvpath" 

         ng-repeat="msg in form.name.$jvlist">{{msg}}</span>
    </td>
</tr>
<tr>
    <td>Last name</td>
    <td>
        <input name="lastname" type="text" ng-model="lastname" jv-path="lastname" />
        <span class="error" ng-if="form.lastname.$error.jvpath" 

         ng-repeat="msg in form.lastname.$jvlist">{{msg}}</span>
    </td>
</tr>
<tr>
    <td>Age</td>
    <td>
        <input name="age" type="text" ng-model="age" jv-path="age" />
        <span class="error" ng-if="form.age.$error.jvpath" 

         ng-repeat="msg in form.age.$jvlist">{{msg}}</span>
    </td>
</tr>
<tr>
    <td>Logins</td>
    <td>
        <table>
          <thead>
            <tr>
            <th>Login</th>
            <th>Password</th>
            <th>Enabled</th>
            <th></th>
            </tr>
          </thead>
          <tbody>
            <tr ng-repeat="row in loginRows" ng-form name="loginForm">
            <td>
                <input name="loginName" type="text" ng-model="row.name" 

                 jv-path="{{'logins['+ $index + '].name'}}" />
                <span class="error" ng-if="loginForm.loginName.$error.jvpath" 

                 ng-repeat="msg in loginForm.loginName.$jvlist">{{msg}}</span>
            </td>
            <td>
                <input name="password" type="text" ng-model="row.password" 

                 jv-path="{{'logins['+ $index + '].password'}}" />
                <span class="error" ng-if="loginForm.password.$error.jvpath" 

                 ng-repeat="msg in loginForm.password.$jvlist">{{msg}}</span>
            </td>
            <td>
                <input name="enabled" type="checkbox" ng-model="row.enabled" 

                 jv-path="{{'logins['+ $index + '].enabled'}}" />
                <span class="error" ng-if="loginForm.enabled.$error.jvpath" 

                 ng-repeat="msg in loginForm.enabled.$jvlist">{{msg}}</span>
            </td>
            <td>
                 <input type="button" ng-click="onRemoveLoginClick(row)" value="Delete" />
            </td>
            </tr>
          </tbody>
        </table>
        <div style="padding-bottom: 0.5em;">
             <input type="button" ng-click="onAddLoginClick()" value="Add" />
        </div>
    </td>
</tr>
</table>
<hr />
<input type="button" ng-click="onSave()" value="Save" />

每个input元素都使用ng-model Angular指令绑定到相应控制器的$scope字段。每个input元素后都带有错误消息span。

<input name="name" type="text" ng-model="name" jv-path="name" />
<span class="error" ng-if="form.name.$error.jvpath" 

ng-repeat="msg in form.name.$jvlist">{{msg}}</span>

或像这样：

<tr ng-repeat="row in loginRows" ng-form name="loginForm">
<td>
    <input name="loginName" type="text" ng-model="row.name" 

     jv-path="{{'logins['+ $index + '].name'}}" />
    <span class="error" ng-if="loginForm.loginName.$error.jvpath" 

     ng-repeat="msg in loginForm.loginName.$jvlist">{{msg}}</span>

如您所见，使用ng-if 和ng-repeat指令修饰的span。这基本上意味着，如果loginForm的name字段验证失败，span则会显示错误消息。第二种情况看起来很奇怪，但是也很简单。jv-path="{{'logins['+ $index + '].name'}}"表示如果logins[0].name字段失败——错误消息将被放置在正确的位置。

查看容器

好吧，就是这样。我们有视图，有控制器，有app.js ，它可以配置所有内容。最后一步是创建一个页面，即单个页面。托管所有视图和控制器的页面。当用户导航到Web应用程序的根目录时，此页面将显示在浏览器中。我的容器页面位于：views/home/Index.cshtml。看起来很简单：

<!DOCTYPE html>
<html ng-app="myclients">
<head>
   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   <title>MyClients Single Page Angular Application</title>
 
   <script type="text/javascript" 

     src="@Url.Content("/Resources/js/vendor/angular.js")"></script>
   <script type="text/javascript" 

     src="@Url.Content("/Resources/js/vendor/angular-route.js")"></script>
   <script type="text/javascript" 

     src="@Url.Content("/Resources/js/vendor/jeneva.angular.js")"></script>
 
   <script type="text/javascript" 

     src="@Url.Content("/Resources/js/app.js")"></script>
   <script type="text/javascript" 

     src="@Url.Content("/Resources/js/filters/idtext.js")"></script>
   <script type="text/javascript" 

     src="@Url.Content("/Resources/js/filters/datetime.js")"></script>
 
   <script type="text/javascript" 

     src="@Url.Content("/Resources/js/controllers/clientCreateController.js")"></script>
   <script type="text/javascript" 

     src="@Url.Content("/Resources/js/controllers/clientListController.js")"></script>
   <script type="text/javascript" 

     src="@Url.Content("/Resources/js/controllers/clientEditController.js")"></script>
   <link href="@Url.Content("~/Resources/css/style.css")" rel="stylesheet"/>
</head>
<body>
    <ng-view>
    </ng-view>
</body>
</html>

首先，我必须使用ng-app指令定义应用程序模块。我的模块称为myclients，这是app.js文件中引用的模块。然后，我必须包含angular.js，jeneva.angular.js以及所有控制器、服务、指令和过滤器。

如您已经猜到的那样，body元素仅包含一个标签——<ng-view>，AngularJS将用当前活动视图替换此标签的内容。就是这样。