接口开发restful

数据库表设计

--员工表
create table Employee
(
    id  NUMBER  primary key,
    employeeID NUMBER not null,
    employeeName VARCHAR2(100) not null,
    employeeSex VARCHAR2(100) not null,
    employeeEmail VARCHAR2(100) not null,
    employeeDepartmentID VARCHAR2(10) not null
)
create unique index Employee_UINDEX on Employee (employeeID)  ---员工id唯一

drop sequence Sequence_Employee_id
--创建一个序列
create  sequence Sequence_Employee_id
    start with 1  --起始值是1000
    increment by 1   --每次增量1
    maxvalue 99999    --最大增量9999

实体类

package com.example.demo.api.restful.entity;

/**
 * 员工主数据
 *
 * @author liuwenlong
 * @create 2022-06-13 22:10:22
 */
@SuppressWarnings("all")
public class Employee {

    /**
     * 员工ID
     */
    private Integer employeeID;

    /**
     * 员工姓名
     */
    private String employeeName;

    /**
     * 员工性别
     */
    private String employeeSex;

    /**
     * 员工邮箱
     */
    private String employeeEmail;

    /**
     * 员工部门ID
     */
    private Integer employeeDepartmentID;


    public Employee() {
    }

    public Integer getEmployeeID() {
        return employeeID;
    }

    public void setEmployeeID(Integer employeeID) {
        this.employeeID = employeeID;
    }

    public String getEmployeeName() {
        return employeeName;
    }

    public void setEmployeeName(String employeeName) {
        this.employeeName = employeeName;
    }

    public String getEmployeeSex() {
        return employeeSex;
    }

    public void setEmployeeSex(String employeeSex) {
        this.employeeSex = employeeSex;
    }

    public String getEmployeeEmail() {
        return employeeEmail;
    }

    public void setEmployeeEmail(String employeeEmail) {
        this.employeeEmail = employeeEmail;
    }

    public Integer getEmployeeDepartmentID() {
        return employeeDepartmentID;
    }

    public void setEmployeeDepartmentID(Integer employeeDepartmentID) {
        this.employeeDepartmentID = employeeDepartmentID;
    }

    @Override
    public String toString() {
        return "Employee{" +
                "employeeID=" + employeeID +
                ", employeeName='" + employeeName + '\'' +
                ", employeeSex='" + employeeSex + '\'' +
                ", employeeEmail='" + employeeEmail + '\'' +
                ", employeeDepartmentID=" + employeeDepartmentID +
                '}';
    }
}

控制类Controller

package com.example.demo.api.restful.controller;

import com.example.demo.api.restful.service.IRestfulService;
import net.sf.json.JSONObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;


/**
 * restful接口
 *
 * @author liuwenlong
 * @create 2022-06-13 14:49:56
 */
@RestController
@SuppressWarnings("all")
@RequestMapping(value = "/restful/api")
public class RestfulController {

    @Autowired
    IRestfulService iRestfulService;

    /**
     * 员工主数据接入接口
     *
     * @param body
     * @return
     */
    @RequestMapping(value = "employeeMasterData", method = RequestMethod.POST)
    public JSONObject employeeMasterData(@RequestBody JSONObject body) {
        return iRestfulService.employeeMasterData(body);
    }
}

接口（Service）

package com.example.demo.api.restful.service;

import net.sf.json.JSONObject;
import org.springframework.web.bind.annotation.RequestBody;

/**
 * @author liuwenlong
 * @create 2022-06-13 22:47:37
 */
@SuppressWarnings("all")
public interface IRestfulService {
    /**
     * 人员主数据接口接入
     *
     * @param body
     * @return
     */
    JSONObject employeeMasterData(@RequestBody JSONObject body);
}

业务实现层（Impl）

package com.example.demo.api.restful.service.impl;

import com.example.demo.api.restful.dao.IRestfulMapper;
import com.example.demo.api.restful.entity.Employee;
import com.example.demo.api.entity.HEAD;
import com.example.demo.api.entity.LIST;
import com.example.demo.api.entity.Response;
import com.example.demo.api.restful.service.IRestfulService;
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.LinkedList;
import java.util.List;

/**
 * @author liuwenlong
 * @create 2022-06-13 22:48:52
 */
@SuppressWarnings("all")
@Service
public class RestfulServiceImpl implements IRestfulService {

    @Autowired
    IRestfulMapper iRestfulMapper;


    /**
     * 人员主数据接口接入
     *
     * @param body
     * @return
     */
    @Override
    public JSONObject employeeMasterData(JSONObject body) {
        try {
            //JSONObject jsonObject = JSONObject.fromObject(body);//将json字符串转为json对象
            String BIZTRANSACTIONID = body.getJSONObject("HEAD").getString("BIZTRANSACTIONID");
            JSONArray requestList = body.getJSONArray("LIST");//得到上游请求来的LIST数组
            List<Employee> employeeList = new LinkedList<>();//存放得到的人员信息

            int successCount = 0;//多少条数据
            int result = 0;//成功失败标识(默认)
            String comments = "成功";//成功标识(默认)
            String errorInfo = "";//失败标识
            String errorCode = "";//失败代码

            //组装反馈HEAD
            HEAD responseHead = new HEAD();
            //组装反馈LIST
            List<LIST> responseLIST = new LinkedList<>();

            
            for (int i = 0; i < requestList.size(); i++) {
                int employeeID = Integer.parseInt(requestList.getJSONObject(i).getString("employeeID"));
                String employeeName = requestList.getJSONObject(i).getString("employeeName");
                String employeeSex = requestList.getJSONObject(i).getString("employeeSex");
                String employeeEmail = requestList.getJSONObject(i).getString("employeeEmail");
                int employeeDepartmentID = Integer.parseInt(requestList.getJSONObject(i).getString("employeeDepartmentID"));
                Employee employee = new Employee();
                employee.setEmployeeID(employeeID);
                employee.setEmployeeName(employeeName);
                employee.setEmployeeSex(employeeSex);
                employee.setEmployeeEmail(employeeEmail);
                employee.setEmployeeDepartmentID(employeeDepartmentID);

                LIST errorList = new LIST();
                try {
                    int insertDBresult = iRestfulMapper.employeeMasterData(employee);//插入数据库
                    successCount++;
                    errorList.setId(employeeID);
                    errorList.setMessage("success");
                } catch (Exception e) {
                    System.out.println(e.getMessage());
                    errorInfo = "错误详情请参考list里对应错误提示";
                    result = 1;
                    errorList.setId(employeeID);
                    errorList.setMessage(e.getCause().toString());
                }
                responseLIST.add(errorList);
            }

            if (result == 1) {
                result = 1;
                comments = "接收失败";
            }

            //组装反馈HEAD
            responseHead.setBIZTRANSACTIONID(BIZTRANSACTIONID);
            responseHead.setRESULT(result);
            responseHead.setCOMMENTS(comments);
            responseHead.setERRORCODE(errorCode);
            responseHead.setERRORINFO(errorInfo);
            responseHead.setSUCCESSCOUNT(successCount);

            //组装完整反馈信息
            Response responseInfo = new Response();
            responseInfo.setHEAD(responseHead);
            responseInfo.setLIST(responseLIST);

            return JSONObject.fromObject(responseInfo);

        } catch (Exception e) {
            String error = "{\"error\":\"" + e.getMessage().replace("\"", "\\\"") + "\"}";
            return JSONObject.fromObject(error);
        }
    }
}

DAO

package com.example.demo.api.restful.dao;

import com.example.demo.api.restful.entity.Employee;

/**
 * @author liuwenlong
 * @create 2022-06-13 22:54:11
 */
@SuppressWarnings("all")
public interface IRestfulMapper {

    /**
     * 人员主数据接口接入
     *
     * @param body
     * @return
     */
    int employeeMasterData(Employee employee);
}

Mapper

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.example.demo.api.restful.dao.IRestfulMapper">

    <!--人员主数据接入-->
    <insert id="employeeMasterData" parameterType="com.example.demo.api.restful.entity.Employee">
     insert into Employee(id,employeeID,employeeName,employeeSex,employeeEmail,employeeDepartmentID)
     values(
              Sequence_Employee_id.NEXTVAL,
              #{employeeID},
              #{employeeName},
              #{employeeSex},
              #{employeeEmail},
              #{employeeDepartmentID}
         )
      </insert>
</mapper>

数据库连接

#连接Oracle数据库
spring.datasource.driver-class-name=oracle.jdbc.driver.OracleDriver
spring.datasource.url=jdbc:oracle:thin:@localhost:1521/orcl
spring.datasource.username=system
spring.datasource.password=123456

#加载Mybatis的xml 在:resources下
mybatis.mapper-locations=classpath*:/com/example/demo/api/restful/dao/*.xml

请求参数说明

接口名称：人员主数据接入接口
2 请求地址：http://localhost:8001/restful/api/employeeMasterData
3 请求方式：post
4 传输类型：application/json

请求报文示例

{
    "HEAD": {
        "BIZTRANSACTIONID": "PMS_ES_001_20210304110203",
        "COUNT": "1",
        "CONSUMER": "ES",
        "SRVLEVEL": "1",
        "ACCOUNT": "",
        "PASSWORD": "",
        "TRANSID": ""
    },
    "LIST": [{
            "employeeID": 10001,
            "employeeName": "张东",
            "employeeSex": "男",
            "employeeEmail": "zhangd@123.com",
            "employeeDepartmentID": 1
        }, {
            "employeeID": 10002,
            "employeeName": "肖瑾",
            "employeeSex": "女",
            "employeeEmail": "xiaoj@123.com",
            "employeeDepartmentID": 2
        }, {
            "employeeID": 10003,
            "employeeName": "孙凯凯",
            "employeeSex": "男",
            "employeeEmail": "sunkk@123.com",
            "employeeDepartmentID": 3
        }
    ]
}

响应报文示例

响应成功报文示例：
{
    "HEAD": {
        "BIZTRANSACTIONID": "PMS_ES_001_20210304110203",
        "COMMENTS": "成功",
        "ERRORCODE": "",
        "ERRORINFO": "",
        "RESULT": 0,
        "SUCCESSCOUNT": 3
    },
    "LIST": [
        {
            "id": 11001,
            "message": "success"
        },
        {
            "id": 11002,
            "message": "success"
        },
        {
            "id": 11003,
            "message": "success"
        }
    ]
}

响应失败报文样例

{
    "HEAD": {
        "BIZTRANSACTIONID": "PMS_ES_001_20210304110203",
        "COMMENTS": "接收失败",
        "ERRORCODE": "",
        "ERRORINFO": "错误详情请参考list里对应错误提示",
        "RESULT": 1,
        "SUCCESSCOUNT": 1
    },
    "LIST": [
        {
            "id": 11004,
            "message": "success"
        },
        {
            "id": 11002,
            "message": "java.sql.SQLIntegrityConstraintViolationException: ORA-00001: 违反唯一约束条件 (SYSTEM.EMPLOYEE_UINDEX)\n"
        },
        {
            "id": 11003,
            "message": "java.sql.SQLIntegrityConstraintViolationException: ORA-00001: 违反唯一约束条件 (SYSTEM.EMPLOYEE_UINDEX)\n"
        }
    ]
}

测试