工业管理软件Api接口和调度功能开发案例-实训指导书.docx

工业管理软件Api接口和调度功能开发案例实训指导书

一、实训目的

本课程的教学目的是让学生掌握工业管理软件Api接口和调度功能的开发流程和关键技术。

从系统的需求分析出发，了解到开发需要实现和满足的实际业务功能点；根据功能点的业务需求。使用VisualStudio2019及以上开发工具对其进行开发实现，然后在功能中进行测试，完成Api接口和调度功能的开发实现及效果验证。

通过综合实训帮助学生全面牢固地掌握教学内容、培养学生的实践动手能力，提高学生综合运用专业知识和专业技能解决实际问题的能力，强化课堂教学与实践教学相结合，锻炼学生的职业能力。

二、实训准备

1、掌握C#编程开发技能。

2、了解工业管理软件的基础开发。

3、事先要能够根据实训工程源代码，配置环境，搭建项目工程。

4、安装好实训开发环境，下载实训工程源代码。

5、Api接口和调度功能的开发依赖于采购订单，需要先完成采购订单功能的开发实现。

三、实训环境

Windows10或以上操作系统(不能是Windows11家庭版)、Visual?Studio2019或以上开发工具安装、数据库可以选择SqlServer数据库（安装VS时将VS自带的SqlServer安装上，就可以不用单独安装SqlServer的数据库）或者Oracle数据库（安装ODAC、安装Oracle客户端、安装PLSQL）、安装EAP.Modelfirst、VS中导入代码片段。

四、实训步骤

任务描述

本实训让学生体验Api接口和调度功能的开发过程。通过本指导书展开详细的开发步骤。

任务：Api接口和调度功能

实现逻辑包括：

Api接口：

传入参数：传入参数：开始时间和结束时间（不可为空），页数（可为空，为空查第一页），页数据量（可为空，为空查所有）；

接口实现逻辑：传入的开始时间和结束时间去跟采购日期进行匹配，开始时间〈=采购日期〈=结束时间，根据页数和页数据量将满足条件的订单和对应订单明细的数据返回；

接口返回值说明：

订单包含的字段内容：订单号、采购日期、订单总金额、订单状态、备注；

订单明细包含的字段内容：产品编码、产品名称、采购价、销售价、采购数量、总金额、备注；

接口完成后需要编写接口卡。

调度任务功能：

调度任务执行逻辑：根据页数和页数据量查询采购信息，查询数据按采购时间的升序进行排序，通过调度定时去更改采购订单的状态，状态变更的条件：

订单对应所有订单明细的入库数量为0，采购订单的状态变更为新建；

订单对应所有订单明细的0〈入库数量〈采购数量，采购订单的状态变更为部分接收；

订单对应所有订单明细的入库数量=采购数量，采购订单的状态变更为全部接收；

调度参数：页数、页数据量，调度任务未配置页数和页数量，提示页数和页数据量必须配置；

调度任务必须记录日志信息。

Api开放接口效果：

图1-1Api开放接口效果

调度任务实现效果：

图1-2调度任务效果

详细开发步骤

Api接口和调度功能开发环境配置介绍

Api接口服务使用的是SIE.WebApiHost，要进行Api接口的调试测试，需要先将实现接口的服务端工程添加依赖到SIE.WebApiHost，如我是在SIE.Test工程实现的接口，需要先将该工程引用到SIE.WebApiHost，并配置对应工程的数据库连接。

图1-3SIE.WebApiHost添加Api接口对应工程依赖和数据库配置

调度功能：

调度平台使用的数据库连接是hangfire，如果调试工程没有添加hangfire的数据库连接，需要先添加上。

图1-4调度连接字符串配置

调试工程需要依赖调度平台相关dll

图1-5调试工程依赖调度的程序集

调度平台的表如果使用的是SQLSERVER的数据库，是可以直接使用平台的升级数据库功能进行表的生成；如果使用的是oracle的数据库，则需要使用脚本在数据库中执行，脚本如下。

图1-6调度平台oracle数据库脚本

以上是做Api接口和调度功能要提前检查和配置的开发环境，环境准备好后，接下来就进入到Api接口和调度功能的开发实现了。

Api接口的功能开发

Api接口返回值订单明细类的定义。

图1-7Api接口返回值订单明细类的定义

Api接口返回值采购订单信息类的定义。

图1-8Api接口返回值订单类的定义

在SIE.Test工程的OrderTests文件夹下定义一个控制器，区分方法的控制器。

图1-9接口控制器的定义

订单控制器类声明为部分类。

图1-10订单控制器类声明为部分类

获取采购订单信息的Api接口的实现

图1-11获取订单Api接口实现

Api接口方法体的逻辑实现

图1-12Api接口方法体的实现

图1-13根据条件查询采购订单方法的实现

接口实现完成后编写接口卡。

图1-14接口卡编写请求效果