H3BPM Controllers 优化方案
-
查询参数优化，尽量使用对象。 InvokingLogController.cs 47
-
将公共方法提取到父类中，避免出现控制器之间的互相调用。 FunctionNodeController.cs 522
-
控制器中不能出现写死的中或者英文。 StartInstanceController.cs 50
-
显示声明方法的作用域。非前端调用的(public)方法增加[NoAction]特性。（public ,private ) InstacneSheetsController.cs 246
-
在控制器内，禁止声明其他类或者枚举，统一在ViewModel/中声明。
-
将控制器按照模块合并，将控制器的粒度缩小（隐患：旧版本无法直接更新Controller.dll）。新增父类控制器，公共方法写在父类控制器中。
-
精简控制器向前端返回的内容，非必要内容不用返回。
-
将业务代码从控制器中抽离，控制器之负责简单逻辑。建立业务层代码。
控制器中的查询参数优化，尽可能使用对象
//参数过多
public JsonResult GetInvokingLogList(PagerInfo pagerInfo, string startTime, string endTime, string serverCode){}
//封装参数
public JsonResult GetInvokingLogList(InvokingLogParam InvokingLogParam){}
将过长的查询参数提取成为一个对象。
命名：ControllerName+Param
将公共方法提取到父类中，避免出现控制器之间的互相调用。
//错误示例
private List<PortalTreeNode> InitReportCodeAndReportingN()
{
//通过构造一个SysDeploymentController对象来调用方法
var result = new SysDeployment.SysDeploymentController().GetReportTreeNodes(this);
return result;
}
//正确示例
private List<PortalTreeNode> InitReportCodeAndReportingN()
{
//将GetReportTreeNodes（）方法提取到公共父类中
var result = base.GetReportTreeNodes();
return result;
}
控制器内禁止出现控制器的相互调用。
控制器中不能出现写死的中或者英文
//错误示例
if (!SSOopenSheet(LoginName, MobileToken))
{
//中文字符禁止出现
result = new ActionResult(false, "登录超时！", null, ExceptionCode.NoAuthorize);
return Json(result, JsonRequestBehavior.AllowGet);
}
//正确示例
if (!SSOopenSheet(LoginName, MobileToken))
{
//中文字符禁止出现
result = new ActionResult(false, "msgGlobalString.LoginTimeOut", null, ExceptionCode.NoAuthorize);
return Json(result, JsonRequestBehavior.AllowGet);
}
务必遵循代码规范，按照代码规范去实现代码，代码的可读性、兼容性等。
显示声明方法的作用域。非前端调用的(public)方法增加[NoAction]特性
//错误示例
string GetSheetCodeByActivity(WorkflowTemplate.Activity Activity)
//正确示例
private string GetSheetCodeByActivity(WorkflowTemplate.Activity Activity)
被声明为 public 的方法，不于前端做数据交互的方法需要增加[NoAction]特性。理论上，在Controllers中的方法都应用于前端数据交互使用，Controllers中就不应该出现这种方法，这样的方法应当提取到父类中，或者将这些和数据交互无关的、业务相关的方法提取到业务层中（Services）。Controllers依赖于Services，由Services去处理业务逻辑。
在控制器内，禁止声明其他类或者枚举，统一在ViewModel/中声明。
一个文件中，只允许声明一个类。
将控制器按照模块合并，将控制器的粒度缩小
数据模型模块
这几个控制器其实都是数据模型模块，里面方法和参数存在重复。可以将类似的控制器合并成一个，提取公共方法到（Services）业务层。
这里提供两种思路：
- 建立一个父类控制器，提取公共方法以及参数到父类控制器和业务类中。
- 将几个相关模块控制器合并成一个。
这里建议第一种方案，但具体模块还得结合实际情况来分析。
精简控制器向前端返回的内容，非必要内容不返回。
给前端返回必要内容即可，不返回冗余的数据。并且尽量使用ActionResult 包装返回内容。
/// <summary>
/// 删除组织权限
/// </summary>
/// <param name="ids">组织权限ID</param>
/// <param name="schemaCode">数据模型编码</param>
/// <returns>删除结果</returns>
[HttpPost]
public JsonResult DeleteBizObjectAcl(string ids, string schemaCode)
{
return ExecuteFunctionRun(() =>
{
ActionResult result = new ActionResult();
if (!this.ParseParam(schemaCode))
{
result.Success = false;
result.Message = "EditBizObjectSchema.Msg0";
return Json(result, JsonRequestBehavior.AllowGet);
}
string ObjectIds = ids;
string[] AclIds = ObjectIds.Split(',');
if (AclIds == null || AclIds.Length == 0)
{
result.Success = false;
result.Message = "msgGlobalString.SelectItem";
}
else
{
this.Engine.BizObjectManager.RemoveBizObjectAcls(schemaCode, "", AclIds);
result.Success = true;
result.Message = "msgGlobalString.DeleteSucced";
}
return Json(result, JsonRequestBehavior.AllowGet);
});
}
返回结果使用 ActionResult 类包装，并且不要返回多余的数据。
将业务代码从控制器中抽离，控制器之负责简单逻辑。建立业务层代码
业务示例
this.ParseParam(schemaCode);
this.Engine.BizObjectManager.RemoveBizObjectAcls(schemaCode, "", AclIds);
都提取至业务类中，Controller层只应该依赖于Service层，不应该直接产生和Engine的依赖。（可以分别对Service和Controller做单元测试）。
更改后的代码：
/// <summary>
/// 数据模型权限控制器
/// </summary>
[Authorize]
public class BizObjectAclController : ControllerBase
{
private BizObjectAclService _bizObjectAclService = null;
/// <summary>
/// 数据模型业务类
/// </summary>
public BizObjectAclService BizObjectAclService
{
get
{
if (null == _bizObjectAclService)
{
_bizObjectAclService = new BizObjectAclService();
}
return _bizObjectAclService;
}
}
/// <summary>
/// 删除组织权限
/// </summary>
/// <param name="ids">组织权限ID</param>
/// <param name="schemaCode">数据模型编码</param>
/// <returns>删除结果</returns>
[HttpPost]
public JsonResult DeleteBizObjectAcl(string ids, string schemaCode)
{
return ExecuteFunctionRun(() =>
{
ActionResult result = new ActionResult();
///实现代码精简
if (!BizObjectAclService.ParseParam(schemaCode))
{
result.Success = false;
result.Message = "EditBizObjectSchema.Msg0";
return Json(result, JsonRequestBehavior.AllowGet);
}
string ObjectIds = ids;
string[] AclIds = ObjectIds.Split(',');
if (AclIds == null || AclIds.Length == 0)
{
result.Success = false;
result.Message = "msgGlobalString.SelectItem";
}
else
{
//实现代码解耦，Controller不再直接依赖于Engine，而依赖于Service
BizObjectAclService.RemoveBizObjectAcls(schemaCode, "", AclIds);
result.Success = true;
result.Message = "msgGlobalString.DeleteSucced";
}
return Json(result, JsonRequestBehavior.AllowGet);
});
}
}
