FastExecutorBook.md · 朽才/FastExecutor

# 前言

FastExecutor是一款基于ASP.NET MVC的快速快发框架，秉承着简洁高效，快速迭代的原则，适用于中小型企业的内部管理系统

# 技术集成

## 后端

DB：基于ADO.NET封装的ORM框架

源码地址：https://gitee.com/grassprogramming/FastORM

IOC/DI：自定开发的IOC容器FastIOC，主要用于系统中依赖注入功能

源码地址：https://gitee.com/grassprogramming/FastIOC

Util：整合框架中常用的自定义工具类与第三方工具类封装FastUtil

源码地址：https://gitee.com/grassprogramming/FastUtil

Message：基于Redis实现基于框架内部的轻量级消息组件

博文地址：

https://blog.csdn.net/u013407099/article/details/101621233

## 前端

基础语言：Vue.js：2.6.1

UI组件框架：ElementUI：2.8.2

网络请求：Jquery：3.1.1

路由：前端cshtml文件，由ASP.NET MVC映射路由

# 部署

## 服务器环境

IIS7.0及以上版本

MySQL数据库5.5及以上版本

Redis数据库3.2.100及以上版本

MySQL Connector Net 6.8.3及以上版本

## 部署方法

1.clone项目至本地

2.编译后发布至文件夹部署至服务器

3.修改数据库连接字符串与Redis连接字符串

4.业务项目建立普通ASP.NET MVC框架，引用框架源码中的FastExecutor.Base，FastExecutor.ORG，FastIOC，FastORM，FastUtil5个dll

5.编译后将业务dll拷贝至部署好框架的Plugin文件夹，可以使用生成后事件命令

copy xxxxx.dll  x:\xxxxxxx\Plugin\xxxxx.dll

6.将业务Views文件夹中的页面文件拷贝至框架的Views文件夹中，或者单独拷贝至磁盘挂载虚拟目录

# 框架解析

## 数据库设计

[数据设计文档.chm](https://gitee.com/grassprogramming/FastExecutor/blob/master/doc/fastexecutor%E8%A1%A8%E7%BB%93%E6%9E%84%E4%BF%A1%E6%81%AF.chm)

[数据库mysql还原文件](https://gitee.com/grassprogramming/FastExecutor/blob/master/doc/fastexector.psc)

## 代码结构说明

FastExecutor：框架工程主体代码，用于框架启动时的一些设置操作

FastExecutor.Base：框架的通用设计层，包含模板，认证工具类，注入工具类等

FastExecutor.ORG：框架自带业务层，包含实体，DB，过滤器，全局枚举类等

FastExecutor.Messgae：框架内部基于Redis实现的轻量级消息组件

## Controller设计

1.基于FastExecutor.Base.Design.FastTemplateController实现模板套用的Controller，快速完成增删改查的开发

2.通过FastExecutor.Base.Design.FastTemplateDB<T>实现泛型数据库增删改查操作

3.通过FastExecutor.Base.Design.FastControllerFactory进行自定义DB的替换与Component的自动注入

博文地址：https://blog.csdn.net/u013407099/article/details/96758717

4.所有系统中的Controller都直接或间接继承自FastExecutor.Base.Design.BaseController，基类中包含登陆人的Token中基本信息，注入好的DB基础操作类与Auth验证类，封装好了获取参数方法

![](https://images.gitee.com/uploads/images/2019/0830/211924_bc648dcf_2074674.png)

## 业务项目集成设计

所有业务项目都是独立的mvc工程，只需要引用相关dll，将编译后的dll拷贝至框架Plugin目录，相关页面拷贝纸框架Views目录，即可无缝衔接，通过FastExecutor.Base.Util.PluginUtil进行插件式的新增，加载与动态更新

1.PreApplicationStartMethod注解执行启动前事件

2.FileSystemWatcher监控业务dll变化

3.BuildManager.AddReferencedAssembly将业务dll代码加入框架工程编译体系

4.RazorBuildProvider将业务系统中映射的cshtml路由加入到框架的路由体系中

5.通过修改webconfig日期达到更新dll后重启IIS的效果

博文地址：https://blog.csdn.net/u013407099/article/details/98662995

![](https://images.gitee.com/uploads/images/2019/0830/211946_172bde8c_2074674.png)

## 认证设计

基于Cookie与Redis的全局身份认证，架构图如下

![输入图片说明](https://images.gitee.com/uploads/images/2019/0830/211953_d091b602_2074674.png)

## webconfig文件配置解读

匿名访问配置部分，跳过登陆验证

```c#
  <AnonymousAccess>
    <Pages>
      <Page url="Frame/Attach/ReadFile" />
      <Page url="Frame/Table/ExportXML" />
      <Page url="Frame/Table/ReadCodeFile" />
      <Page url="Frame/Home/Login" />
      <Page url="Frame/Auth/" />
      <Page url="Frame/Error/" />
    </Pages>
  </AnonymousAccess>
```

文件上传配置

```
    
    <add key="AttachStorageType" value="DB"/>
    
    <add key="AttachVirtualPath" value="AttachFile"/>
    
    <add key="AttachTempPath" value="AttachTempFile"/>
```

Redis及登陆验证配置

```c#
    
    
    <add key="RedisConnectionString" value="127.0.0.1:6379" />
    
    <add key="SessionTimeOut" value="30" />
    
    <add key="TokenPrefix" value="FastExecutor" /
```

其他系统配置

```c#
    
    
    <add key="CodeTempPath" value="CodeTempFile"/>
    
    <add key="DefaultHomeUrl" value="Frame/Home/Index"/>
    
    <add key="SystemName" value="FastExecutor管理系统"/>
```

# 框架使用

## 框架工具类使用

1.创建主键Guid

```c#
CommonUtil.CreateCommonGuid()
```

2.获取当前项目的IP及项目名称 ,结果示例：http://localhost/FastExecutor

```c#
CommonUtil.GetRootPath()
```

3.获取客户端访问的IP

```c#
CommonUtil.GetClientIP()
```

4.获取Token信息（一定是要在请求的上下文或涉及的DB操作中）

```
InjectUtil.Container.Resolve<AuthUtil>().GetToken()
```

5.在普通的需要Token认证的类中使用FastAllowAnonymousAttribute注解标记某个API可以单独匿名访问

6.在类或者方法中使用FastSQLInjectionAttribute注解标记，启用SQL注入防护

## 消息组件使用

1.新建消息处理类继承自FastDefaultMessageHandler

2.使用MessageChanelAttribute标记处理类并指定ChannelName

3.重写CustomHandle（处理消息）与CheckMessageIsConsume（确认消息消费）方法

4.使用MessageCenter.GetInstance().SendMessage方法发送消息，发送的实体类要与CustomHandle方法中反序列化的类型一致

示例：

```c#
    [MessageChanelAttribute(ChannelName = "Login")]
    public class LoginLog : FastDefaultMessageHandler
    {
        public override void CustomHandle(Message.Design.Message Message)
        {
            Frame_LoginLog LogEntity = JsonConvert.DeserializeObject<Frame_LoginLog>(Message.MessageBody.MessageJsonContent);
            @DBUtil.Insert(LogEntity);
            base.CustomHandle(Message);
        }

public override bool CheckMessageIsConsume(Message.Design.Message Message)
        {
            Frame_LoginLog LogEntity = JsonConvert.DeserializeObject<Frame_LoginLog>(Message.MessageBody.MessageJsonContent);
            DBRow Row = new DBRow("Frame_LoginLog", "RowGuid", LogEntity.RowGuid);
            if (Row.IsExist())
            {
                return true;
            }
            else
            {
                return false;
            }
        }
    }
```

# 业务系统开发

## 建表

后台管理——数据管理平台——DMP平台（业务项目表统一使用DMP平台管理）

1.添加数据表

2.添加表结构，定义适当的参数类型与控件选择

3.表结构列表中勾选数据表生成代码，代码包含前段端的新增，编辑，列表页面文件，后端包含实体类，DB类，Controller,将这些文件放入工程中对应的文件夹中

## 后端个性化开发

1.默认的生成的DB文件一般只重写新增方法用于主键生成，你可以重写其中任何方法，DB文件会被自动替换到Controller中的默认的DB泛型模板中

2.如果生成的DB中的方法不足以满足要求，可以自己创建方法，但是需要在Controller中声明DB类，而不能使用基类中的模板，代码示例如下

```c#
  [AutoWired]
  public DB_User @DB_User;
```

3.生成的Controller中也会包含基本的操作api，如果相对List查找操作增加个性化条件，代码如下

```c#
  JObject Params = GetParams();
  string DisplayName = Convert.ToString(Params["DisplayName"]);
  if (!string.IsNullOrEmpty(DisplayName))
  {
      ListWhereText += string.Format(" and DisplayName like '%{0}%'", DisplayName);
  }
```

4.想要个性化返回结果，代码如下,ReturnValue默认包含code和msg两个返回值，可以通过Add方法重写

```c#
 ReturnValue result = new ReturnValue();
 result.Add("code", -100);
 result.Add("msg", "已存在相同名称的表！");
 return result;
```

5.如果在最终的表现层不是Controller的代码中使用自动注入（拦截器，过滤器，日志，任务等），获取复杂对象（对象中在别的地方使用，而对象中嵌套自动注入）时的代码如下

```c#
private AuthUtil @AuthUtil = InjectUtil.Container.Resolve<AuthUtil>();
```

## 前端个性化开发

如果生成的前端页面无法完全满足需求，新建一个cshtml文件，需要引入框架js与css，代码如下

```cshtml
<!DOCTYPE html>

<html>

<head>
    <meta name="viewport" content="width=device-width" />
    <title></title>
    @Scripts.Render("~/Resource/js/fe.head.js")
</head>

</div>
</body>
@Scripts.Render("~/Resource/js/fe.foot.js")
<script>
    var pageData = {};
    new Vue({
        el: '#app',
        data: pageData,
        mounted: function () {

},
        methods: {
          
        }
    })
</script>

</html>
```

### dialog弹窗使用

博文地址：https://blog.csdn.net/u013407099/article/details/86552635

项目源码：https://gitee.com/grassprogramming/FastDialog-Vue

普通打开页面

```
 OpenDialog("111", "打开窗口", "newpage1.html", "600", "1200");
```

参数：dialog标识，页面标题名称，页面url地址，页面高度，页面宽度
百分比打开页面

```
OpenDialog("111", "打开窗口", "newpage1.html", "70", "80",null,null,"%");
```

注：第8个参数为宽高的单位，不传默认px

打开的页面关闭后，主页面触发回调函数

```
OpenDialog("222", "关闭窗口有回调函数", "newpage1.html", "600", "1200", AfterClose);
```

打开的页面关闭后，主页面触发回调函数,回调函数包含关闭页面传递的返回值

```
 OpenDialog("333", "回掉函数包含返回值", "newpage1.html", "600", "1200", AfterCloseWithReturn);
 function AfterCloseWithReturn(ReturnValue) {
        alert("page1回传的参数："+ReturnValue);
 }
```

打开页面并传递参数

```
 OpenDialog("444", "有回调函数并传参", "newpage1.html", "600", "1200", AfterCloseWithReturn, "125sds");
```

打开页面获取参数

```
var params = GetParams();
 if (params && params != "undefined") {
     alert("打开页面接收的参数：" + params);
}
```

关闭打开的页面

```
CloseDialog();
```

关闭打开的页面并向主页面传递返回值，配合3使用

```
CloseDialog("page1回传222222");
```

在顶层窗口打开页面，一般用于iframe中

```
OpenTopDialog("777777", "有回调函数并传参", "newpage2.html", "500", "1000", AfterCloseWithReturn, "page1-page2传参");
```

关闭顶层页面

```
CloseDialog("page2回传111111","page3");
```

注：CloseDialog方法在关闭OpenDialog的页面，无需传参，或者传返回值，关闭OpenTopDialog的页面时必须传入两个参数，ReturnValue和打开的dialog的id标识，无返回值传null，如果一个页面同时需要被 OpenDialog和OpenTopDialog打开，两个参数必传

打开普通提示窗

```
 OpenAlert("提示", "请在规定期限内处理完成！");
```

关闭提示窗关闭后触发回调事件

```
OpenAlert("提示", "请在规定期限内处理完成！",AfterClose);
```

打开成功提示窗

```
OpenSuccess("提示", "请在规定期限内处理完成！");
```

打开警告提示窗

```
 OpenWaring("提示", "请在规定期限内处理完成！",null,"知道了");
```

打开失败提示窗

```
 OpenFail("提示", "请在规定期限内处理完成！");
```

打开确认提示窗

```
OpenConfirm("确认提示", "是否删除当前数据", function () {
                    OpenSuccess("提示", "删除成功");
                });
OpenConfirm("确认提示", "是否删除当前数据", function () {

}, "确认删除", "取消操作");
```

### table组件使用

框架中的table组件就是基于elementui，将表格与分页以及一些默认配置进行封装，使用代码如下

```
 <common-table :data="tableData" :page-Index="pageIndex" :page-Size="pageSize" :total="total" :table-Height="tableHeight" :show-Delete="false" v-on:on-load="bindGrid"
 v-on:on-pageindexchange="pageIndexChange" v-on:handle-edit="edit" ref="table">
 </common-table>
```

1.common-table组件自带多选框（showCheckBox控制），序号列（showIndex控制），编辑列（showEdit控制，handleEdit方法），删除列（showDelete控制，handleDelete方法）

2.common-table组件自带分页控件，传入page-Index，page-Size控制，对外提供on-pageindexchange翻页事件修改页数，对外提供on-load方法用于表格数据的加载来刷新翻页数据

3.common-table声明列表数据结构代码如下

```
<template slot="column">
       <el-table-column prop="TableName" header-align="center" align="left" label="表名">
        </el-table-column>
</template>
```

4.common-table声明自定义操作列代码如下,在有默认操作栏的情况下支持opbefore与opafter两种位置不同发slot

```
 <template slot="opbefore">
     <el-table-column prop="ColumnDetail" header-align="center" align="center" label="表结构" width="100">
      <template slot-scope="scope">
         <el-button type="danger" size="mini" v-on:click="columnDetail(scope.row)">表结构
         </el-button>
      </template>
	</el-table-column>
</template>

```

### 树组件使用

1.支持单选,指定tree-Model="single"

```
 <common-tree :tree-data="treeData" tree-Model="single" :tree-select-value="form.OUGuid"
      v-on:node-select-change="nodeChange" :tree-body-width="630">
  </common-tree>

```

2.支持多选,指定tree-Model="multi"

```
 <common-tree :tree-data="ouTreeData" tree-Model="multi" :tree-select-array="ouList"
    v-on:node-select-change="ouNodeChange" :tree-body-width="650" :tree-body-height="220"
    :only-leaf="true">
 </common-tree>

```

3.支持展示树,默认tree-Model="normal"

```
 <common-tree :tree-data="treeData" :tree-body-height="treeHeight" v-on:tree-node-			click="nodeClick">
 </common-tree>

```

4.树属性

treeHolder：默认无数据时的文字

treeSelectArray：多选树时的传入选择值（数组）

treeSelectValue：单选树时传入的选择值（字符串）

treeData：绑定的数据源

treeModel：树展示类型

disabled：多选单选时是否能编辑选择的值

onlyLeaf：是否只选择叶子节点

showSearchInput：是否显示树的搜索框

treeBodyHeight：控件高度

treeBodyWidth：控件宽度

5.树事件

选择树节点事件node-select-change

单选：返回字符串

多选：返回数组

树节点点击事件：tree-node-click（仅支持展示树）

### 上传控件使用

1.普通上传文件，指定controltype为upload,需要传入groupguid（记录主键），grouptype（同一批文件的分类标识）

```
 <common-upload :groupguid="form.RowGuid" :grouptype="GroupType" controltype="upload">
 </common-upload>

```

2.上传头像,指定controltype为image

```
 <common-upload :groupguid="form.RowGuid" :grouptype="GroupType" controltype="image">
 </common-upload>

```

## 配置菜单

后台管理——系统管理——模块管理

选好父级模块，点击添加模块按钮，填写模块名称与模块路由地址，例如部门管理：Frame/OU/List

后台管理——权限管理——模块权限

搜索你需要配置的菜单，点击编辑，设置部门/人员/角色权限，使用对应账号登陆即可查看菜单，如果你只配置了子菜单权限，而父级菜单未配置权限，框架会自动填充

朽才/FastExecutor

简介

发行版

贡献者

近期动态

朽才/FastExecutor .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

朽才/FastExecutor