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

工业管理软件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接口卡编写请求效果图1-15接口卡编写返回值效果到这，Api接口的开发完成了。调度功能的开发实现调度参数类的开发实现。图1-16调度参数类的开发实现调度参数界面类的开发实现。图1-17调度参数界面类的开发实现根据业务条件保存订单逻辑的方法实现。图1-18保存订单信息调度类的开发实现。图1-19调度类的开发实现运行项目，配置调度任务，我们开发的采购订单任务在调度任务设置，添加按钮中可以展示出来。图1-20实现的调度任务到这，采购订单的状态更改调度任务就都开发完成了。效果验证以SIE.WebApiHost启用，允许SIE.WebApiHost项目，项目启动成功的效果。图1-21SIE.WebApiHost启动成功效果将服务的IP和端口复制到浏览器中效果，将*改成localhost。图1-22SIE.WebApiHost浏览器运行效果接口实现的效果。图1-23接口实现效果-参数和返回值说明图1-24接口实现效果-接口请求图1-25接口实现效果-接口响应在Api使用说明中获取票据。图1-26获取票据将票据粘贴到Api方法GetPurOrderList请求中的Ticket，配置传入参数的开始时间和结束时间。图1-27粘贴票据，配置传入参数开始时间和结束时间点击请求，查询Api接口的返回值效果图1-28供应商标签打印按钮效果到这Api接口的效果就验证完成了，如果返回值存在问题，可以在Api方法中设置断点，点击Post进行调试测试原因。在调度任务设置中添加调度任务。图1-29添加调度任务配置调度的表达式，如果要根据cron表达式定期执行周期，依赖于调度服务，实际项目中该表达式的执行周期不建议设置太短。图1-30cron表达式配置配置方法参数、库存组织和员工，点击保存，保存任务图1-31配置方法参数、库存组织和员工未配置任务参数，点击运行，日志中会记录错误，参数未配置。图1-32未配置参数任务执行效果调度任务参数配置，按如下配置，配置完成后点击保存数据。图1-33调度参数配置配置参数后，点击运行，调度任务执行的效果图1-34配置任务参数调度任务执行效果调度任务的验证到这也就完成了，如果调度任务执行保存，可以在job的ExecuteJob方法中