首頁 > 軟體

Java如何提供給第三方使用介面方法詳解

2022-08-23 18:01:09

前言

相信有很多小夥伴,在日常的開發中都有遇到過需要呼叫第三方介面的需求吧,但是自己有沒有寫過介面提供給第三方使用呢,常規的都是我們呼叫別人的介面,但是自己需要開發介面提供給第三方使用的場景應該不是很多,很多小夥伴可能會想不就開發一個介面對外開放嘛豈不是很簡單,但是在開發介面對外開放,我們需要考慮一個問題,沒有限制條件,那豈不是太不安全了,誰都可以調我這個介面了啊。

所以接下來的就是我們需要考慮的問題了,在開發介面的時候就要考慮到安全性的問題,那麼應該如何去解決這個問題呢?提供介面給第三方使用的時候需要加上校驗保證介面的安全性。

下面是我寫的一個例子希望對大家有幫助。

介面Controller

在寫介面前一定要簽名做簽名校驗,我的簽名方式做了特殊處理,因為介面是對外開放的,這個是為了避免惡意呼叫介面做的處理,叫做簽名的混淆值,這個簽名混淆值的作用是就算別人知道了介面,並且知道簽名方式也不能被攻擊,是為了避免被惡意篡改資料,簽名混淆值就是一組特定加密後的資料。

	@PostMapping("refundDeductionPoints")
	public Result<SysIntegralStatement> refundDeductionPoints (@RequestParam Map<String,String> params){
		Result<SysIntegralStatement> result = new Result<SysIntegralStatement>();
		try {
			//簽名校驗
			String msgDigest = params.get("msgDigest");//簽名
			String msgData = params.get("msgData");
			String timeStamp = params.get("timeStamp");
			String secret = params.get("secret");//	祕鑰
			String sign = SignUtil.sign(msgData+"wf8la1tw7p9o2xz",timeStamp);//wf8la1tw7p9o2xz為簽名混淆值
			if (!msgDigest.equals(sign)) {
				return result.setCode(1006).setReason("數位簽章無效");
			}
			if (Common.isEmpty(secret)) {//先簽名後冪等校驗
				return result.setCode(1001).setReason("金鑰不能為空");
			}
			/**
			 * 冪等校驗
			 * 1.同一個使用者操作同一個退貨單一分鐘內操作該單據視為重複操作(此祕鑰已通過特殊處理)
			 */
			String value = redistempalte.opsForValue().get(secret);
			if (Common.isNotEmpty(value)) {	
				logger.error("重複請求 secret={}",value);
				return result.setCode(1007).setReason("重複請求");	
			}
			redistempalte.opsForValue().set(secret, "1",60,TimeUnit.SECONDS);//設定快取一分鐘
			return service.refundDeductionPoints(params);
		} catch (Exception e) {
			logger.error("新增積分流水異常", e);
			return result.setCode(ErrorCodes.BUSINESS_ERROR).setReason("生成積分流水失敗");
		}
	}

介面冪等性校驗

此介面做冪等性校驗,冪等性校驗常見解決方案有很多,可以自行根據實際情況選擇,

說到冪等首先要先了解什麼是冪等

概念:

冪等(idempotent、idempotence)是一個數學與計算機學概念,常見於抽象代數中。

在程式設計中.一個冪等操作的特點是其任意多次執行所產生的影響均與一次執行的影響相同。冪等函數,或冪等方法,是指可以使用相同引數重複執行,並能獲得相同結果的函數。

這些函數不會影響系統狀態,也不用擔心重複執行會對系統造成改變。例如,“getUsername()和setTrue()”函數就是一個冪等函數.

冪等性, 通俗的說就是一個介面, 多次發起同一個請求, 必須保證操作只能執行一次,比如:

訂單介面, 不能多次建立訂單

支付介面, 重複支付同一筆訂單隻能扣一次錢

支付寶回撥介面, 可能會多次回撥, 必須處理重複回撥

普通表單提交介面, 因為網路超時等原因多次點選提交, 只能成功一次

等等

解決方案常見的幾種方式

唯一索引 – 防止新增髒資料

token機制 – 防止頁面重複提交

悲觀鎖 – 獲取資料的時候加鎖(鎖表或鎖行)

樂觀鎖 – 基於版本號version實現, 在更新資料那一刻校驗資料

分散式鎖 – redis(jedis、redisson)或zookeeper實現

狀態機 – 狀態變更, 更新資料時判斷狀態

如果有小夥伴不理解什麼是冪等可以看看官方是解釋

實現類ServiceImpl

	@Transactional
	@Override
	public Result<SysIntegralStatement> refundDeductionPoints(Map<String, String> params) {
		String msgData = params.get("msgData");
		ParamIntegral entity = new Gson().fromJson(msgData, ParamIntegral.class);
		if (Common.isNull(entity)) {
			return new Result<SysIntegralStatement>().setCode(ErrorCodes.INNER_ERROR).setReason("請求引數不能為空");
		}
		if (Common.isEmpty(entity.getBitems())) {
			return new Result<SysIntegralStatement>().setCode(ErrorCodes.INNER_ERROR).setReason("請求引數不能為空");
		}
		int row = 0;
		for (ParamIntegral bitem : entity.getBitems()) {
			if (Common.isEmpty(bitem.getDdh())) {
				return new Result<SysIntegralStatement>().setCode(ErrorCodes.INNER_ERROR).setReason("訂單號為必傳引數");
			}
			if (null == bitem.getJfz()) {
				return new Result<SysIntegralStatement>().setCode(ErrorCodes.INNER_ERROR).setReason("扣減積分不能為空");
			}
			List<MallOrderInfo> orderInfo = mallOrderInfoMapper.selectByDdh(bitem.getDdh());
			if (orderInfo == null) {
				return new Result<SysIntegralStatement>().setCode(ErrorCodes.INNER_ERROR)
						.setReason("訂單號為" + bitem.getDdh() + "沒有此訂單請聯絡客服核對資訊。");
			}
			if (orderInfo != null && orderInfo.size() > 1) {
				return new Result<SysIntegralStatement>().setCode(ErrorCodes.INNER_ERROR)
						.setReason("訂單號為" + bitem.getDdh() + "有多個相同訂單請聯絡客服核對資訊。");
			}
			if (!"E".equals(orderInfo.get(0).getDdzt())) {
				return new Result<SysIntegralStatement>().setCode(ErrorCodes.INNER_ERROR)
						.setReason("訂單號為" + bitem.getDdh() + "未確認收貨還沒產生積分不允許退貨。");
			}
			SysIntegral integral = Common.first(integralMapper.selectByMdbm(orderInfo.get(0).getMdbm()));
			if (integral == null) {
				return new Result<SysIntegralStatement>().setCode(ErrorCodes.INNER_ERROR)
						.setReason("門店編碼為" + orderInfo.get(0).getMdbm() + "積分彙總沒有找到此門店,請聯絡客服核實");
			}
			BigDecimal kyjf = BigDecimal.ZERO;
			if (entity.getReturnGoods() == true) {
				// 可用積分小於扣減積分不夠扣ERP使用前抵扣
				if (bitem.getJfz().compareTo(integral.getKyjf()) == 1) {
					kyjf = BigDecimal.ZERO;					
				} else {
					// 可用積分 = 當前可用積分-扣減積分
					kyjf = Common.nvl(integral.getKyjf(), BigDecimal.ZERO).subtract(bitem.getJfz());
				}
			} else {
				// 可用積分 = 當前可用積分+退還積分
				kyjf = Common.nvl(integral.getKyjf(), BigDecimal.ZERO).add(bitem.getJfz());				
			}		
			// 更新積分彙總
			SysIntegral dataMap = new SysIntegral();
			dataMap.setIntegralId(integral.getIntegralId());
			dataMap.setMdbm(integral.getMdbm());
			dataMap.setKyjf(kyjf);
			dataMap.setUpdateTime(new Date());
			dataMap.setUpdateUser(entity.getUserName());
			dataMap.setUpdateUserid(entity.getUserId().intValue());		
			row = integralMapper.updateByPrimaryKeySelective(dataMap);
			if (row == 0) {
				TransactionAspectSupport.currentTransactionStatus().setRollbackOnly();
				return new Result<SysIntegralStatement>().setCode(ErrorCodes.INNER_ERROR).setReason("更新積分失敗");
			}
			//推播到ERP門店資訊
			 BdMdxxH mdxx =new BdMdxxH();
			 mdxx.setMdbm(integral.getMdbm());
			 mdxx.setMdjf(kyjf);
			com.lkfs.cw.common.Result<BdMdxxH> bdMdxxh = dataBaseServiceApi.updateStorePoints(mdxx);
			if (!bdMdxxh.isComplete()) {
				TransactionAspectSupport.currentTransactionStatus().setRollbackOnly();
				return new Result<SysIntegralStatement>().setCode(bdMdxxh.getCode()).setReason(bdMdxxh.getReason());
			}		
			SysIntegralStatement statement = new SysIntegralStatement();
			if (entity.getReturnGoods() == true) {
				statement.setJfz(bitem.getJfz().negate());// 消費的積分值
				if (bitem.getJfz().compareTo(integral.getKyjf()) == 1) {// 可用積分小於扣減積分不夠扣ERP使用前抵扣
					statement.setTzhjfz(BigDecimal.ZERO);// 調整後積分值
				} else {
					statement.setTzhjfz(Common.nvl(integral.getKyjf(), BigDecimal.ZERO).subtract(bitem.getJfz()));// 調整後積分值
				}
				statement.setJfxflx("E");// 積分支出
				statement.setXxsm("退貨扣減積分(訂單號為:" + bitem.getDdh() + "," + "退貨單號為:" + entity.getDjh() + ")" + "已扣除:"
						+ bitem.getJfz().negate() + ":積分");
			} else {// 取消退貨
				statement.setJfxflx("I");// 積分收入
				statement.setJfz(bitem.getJfz());// 取消退貨把積分贈送回來
				statement.setTzhjfz(Common.nvl(integral.getKyjf(), BigDecimal.ZERO).add(bitem.getJfz()));// 調整後積分值
				statement.setXxsm("取消退貨(訂單號為:" + bitem.getDdh() + "," + "退貨單號為:" + entity.getDjh() + ")" + "已退還:"
						+ bitem.getJfz() + ":積分");
			}
			statement.setIntegralId(integral.getIntegralId());// 該門店積分編碼
			statement.setTzqjfz(integral.getKyjf());// 調整前積分值
			statement.setDdh(entity.getDdh());
			statement.setCreateTime(new Date());// 流水生成時間
			statement.setCreateUser(entity.getUserName());
			statement.setCreateUserid(entity.getUserId().intValue());
			statement.setJftz("T");// 積分扣減為T
			statement.setZt("Y");// 狀態 Y:有效
			row = mapper.insert(statement);
			if (row == 0) {
				TransactionAspectSupport.currentTransactionStatus().setRollbackOnly();
				return new Result<SysIntegralStatement>().setCode(ErrorCodes.INNER_ERROR).setReason("插入積分流水失敗");
			}
		}
		return new Result<SysIntegralStatement>().setCode(ErrorCodes.SUCCESS).setReason("操作成功");
	}

第三方呼叫介面Api實現類

模擬第三方合作方呼叫介面

//此方式以上已寫了封裝資訊就不一一展示了,可以根據實際情況自行操作
	private void pushIntegral(Long djlsh) {
		FiSjysjsH fiSjysjsh = mapper.selectByPrimaryKey(djlsh);				
		//訂單退貨呼叫某某退貨扣減積分介面
		List<FiSjysjsB> sjysjsbList = bmapper.selectByKhddh(djlsh);
		if (sjysjsbList != null && sjysjsbList.size() > 0) {
			List<ParamIntegral> list = new ArrayList<ParamIntegral>();
			for (FiSjysjsB bitem : sjysjsbList) {
				ParamIntegral temp = new ParamIntegral();
				temp.setDdh(bitem.getKhddh());
				temp.setJfz(bitem.getJfz());			
				list.add(temp);
			}
			ParamIntegral param = new ParamIntegral();
			param.setBitems(list);
			param.setDjh(fiSjysjsh.getDjh());
			param.setUserId(AppRealm.getCurrentUser().getUserId());
			param.setUserName(AppRealm.getCurrentUser().getUserName());
			if (new Short("1").equals(fiSjysjsh.getLocked())) {
				param.setReturnGoods(true);
			}else {
				param.setReturnGoods(false);
			}
			String msgData = new Gson().toJson(param).toString();
			Map<String, String> params = new HashMap<String, String>();
			String timeStamp = String.valueOf(System.currentTimeMillis());//時間戳
			params.put("timeStamp", timeStamp);
			params.put("msgData", msgData);	
			params.put("msgDigest", SignUtil.sign(msgData+"wf8la1tw7p9o2xz", timeStamp));//生成簽名第二個值暫定(wf8la1tw7p9o2xz簽名混淆值)
			params.put("secret",IDEMPOTENT_SECRET_PREFIX + fiSjysjsh.getDjh() + AppRealm.getCurrentUser().getUserId()+param.getReturnGoods() );//自定義金鑰 做冪等校驗
			String result = HttpCilent.post(B2B_URL, params); //傳送http post請求
			B2bIntegralResponse res = new Gson().fromJson(result, B2bIntegralResponse.class);
			if (null == res) {
				throw new RuntimeException("呼叫積分介面系統異常");
			}
			if (res.getCode() != 0) {//介面返回失敗異常程式碼提示
				throw new RuntimeException("呼叫積分介面發生異常,異常程式碼為:"+res.getCode()+"異常資訊為:"+res.getReason());	
			}
		}
	}

生成簽名工具類

package com.cy.xgsm.util;

import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;

/**
 * 
 * @author Dylan
 *
 */
public class SignUtil {
	
private static final Logger log = LoggerFactory.getLogger(SignUtil.class);
	
	/**
	 * 
	 */
	public static String sign(String str, String secret) {
		StringBuilder enValue = new StringBuilder();
		enValue.append(secret);
		enValue.append(str);
		enValue.append(secret);
		return encryptByMD5(enValue.toString());
	}

	private static String encryptByMD5(String data) {
		String re_md5 = new String();
		try {
			MessageDigest md = MessageDigest.getInstance("MD5");
			md.update(data.getBytes());
			byte b[] = md.digest();
			int i;
			StringBuffer buf = new StringBuffer();
			for (int offset = 0; offset < b.length; offset++) {
				i = b[offset];
				if (i < 0)
					i += 256;
				if (i < 16)
					buf.append("0");
				buf.append(Integer.toHexString(i));
			}
			re_md5 = buf.toString();
		} catch (NoSuchAlgorithmException e) {
			e.printStackTrace();
		}
		return re_md5.toUpperCase();
	}

	public static String compare(String jsonStr,String secret ){

		JsonParser jsonParser = new JsonParser();
		JsonObject jsonObject = jsonParser.parse(jsonStr).getAsJsonObject();
		String sign1 = "null";
		JsonElement signElement = jsonObject.remove("sign");
		if( signElement != null ){
			sign1 = signElement.getAsString();
		}
		log.info("sign1: " + sign1);
		StringBuilder enValue = new StringBuilder();
		enValue.append(secret);
		enValue.append(jsonObject.toString());
		enValue.append(secret);
		String sign2 = encryptByMD5(enValue.toString());
		jsonObject.addProperty("sign", sign2);
		return jsonObject.toString();
	}
}

HttpCilent工具類

這個工具類在我之前的文章也有但是沒有把這個方式的放上去,如果有需要用到可直接把一下程式碼複製到這個Http工具類(見文末) 最後即可直接使用。

   /**
     * 傳送post請求
     * @param url 目的url
     * @param parameters 引數
     * @return
     */
    public static String post(String url, Map<String, String> parameters) {
    	String result = "";// 返回的結果
    	BufferedReader in = null;// 讀取響應輸入流
    	PrintWriter out = null;
    	StringBuffer sb = new StringBuffer();// 處理請求引數
    	String params = "";// 編碼之後的引數
    	try {
    	// 編碼請求引數
    	if (parameters.size() == 1) {
    	for (String name : parameters.keySet()) {
    	sb.append(name)
    	.append("=")
    	.append(java.net.URLEncoder.encode(
    	parameters.get(name), "UTF-8"));
    	}
    	params = sb.toString();
    	} else {
    	for (String name : parameters.keySet()) {
    	sb.append(name)
    	.append("=")
    	.append(java.net.URLEncoder.encode(
    	parameters.get(name), "UTF-8")).append("&");
    	}
    	String temp_params = sb.toString();
    	params = temp_params.substring(0, temp_params.length() - 1);
    	}
    	// 建立URL物件
    	java.net.URL connURL = new java.net.URL(url);
    	// 開啟URL連線
    	java.net.HttpURLConnection httpConn = (java.net.HttpURLConnection) connURL
    	.openConnection();
    	// 設定通用屬性
    	httpConn.setRequestProperty("Accept", "*/*");
    	httpConn.setRequestProperty("Connection", "Keep-Alive");
    	httpConn.setRequestProperty("content-type", "application/x-www-form-urlencoded");
    	httpConn.setRequestProperty("User-Agent",
    	"Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1)");
    	// 設定POST方式
    	httpConn.setDoInput(true);
    	httpConn.setDoOutput(true);
    	// 獲取HttpURLConnection物件對應的輸出流
    	out = new PrintWriter(httpConn.getOutputStream());
    	// 傳送請求引數
    	out.write(params);
    	// flush輸出流的緩衝
    	out.flush();
    	// 定義BufferedReader輸入流來讀取URL的響應,設定編碼方式
    	in = new BufferedReader(new InputStreamReader(
    	httpConn.getInputStream(), "UTF-8"));
    	String line;
    	// 讀取返回的內容
    	while ((line = in.readLine()) != null) {
    	result += line;
    	}
    	} catch (Exception e) {
    	e.printStackTrace();

    	} finally {
    	try {
    	if (out != null) {
    	out.close();
    	}
    	if (in != null) {
    	in.close();
    	}
    	} catch (IOException ex) {
    	ex.printStackTrace();
    	}
    	}
    	return result;
    	}

附:分享一個獲取IP工具類

在日常開發中,經常會遇到需要記錄IP的需求,接下來分享一個獲取IP工具類,希望對小夥伴有幫助

package com.cy.xgsm.util;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.net.InetAddress;
import java.net.UnknownHostException;
import javax.servlet.http.HttpServletRequest;

/**
 * 獲取IP工具類
 * @author Dylan
 *
 */
public class IpUtils {
	
	private static Logger logger = LoggerFactory.getLogger(IpUtils.class);

	/**
	 * 獲取IP地址
	 * 使用Nginx等反向代理軟體, 則不能通過request.getRemoteAddr()獲取IP地址
	 * 如果使用了多級反向代理的話,X-Forwarded-For的值並不止一個,而是一串IP地址,X-Forwarded-For中第一個非unknown的有效IP字串,則為真實IP地址
	 */
    public static String getIpAddr(HttpServletRequest request)
    {
        if (request == null)
        {
            return "unknown";
        }
        String ip = request.getHeader("x-forwarded-for");
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getHeader("Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getHeader("X-Forwarded-For");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getHeader("WL-Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getHeader("X-Real-IP");
        }

        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getRemoteAddr();
        }

        return "0:0:0:0:0:0:0:1".equals(ip) ? "127.0.0.1" : ip;
    }

    public static boolean internalIp(String ip)
    {
        byte[] addr = textToNumericFormatV4(ip);
        return internalIp(addr) || "127.0.0.1".equals(ip);
    }

    private static boolean internalIp(byte[] addr)
    {
        if (StringUtils.isNull(addr) || addr.length < 2)
        {
            return true;
        }
        final byte b0 = addr[0];
        final byte b1 = addr[1];
        final byte section1 = 0x0A;
        final byte section2 = (byte) 0xAC;
        final byte section3 = (byte) 0x10;
        final byte section4 = (byte) 0x1F;
        final byte section5 = (byte) 0xC0;
        final byte section6 = (byte) 0xA8;
        switch (b0)
        {
            case section1:
                return true;
            case section2:
                if (b1 >= section3 && b1 <= section4)
                {
                    return true;
                }
            case section5:
                switch (b1)
                {
                    case section6:
                        return true;
                    default:
                        return false;    
                }
            default:
                return false;
        }
    }

    /**
     * 將IPv4地址轉換成位元組
     * 
     * @param text IPv4地址
     * @return byte 位元組
     */
    public static byte[] textToNumericFormatV4(String text)
    {
        if (text.length() == 0)
        {
            return null;
        }

        byte[] bytes = new byte[4];
        String[] elements = text.split("\.", -1);
        try
        {
            long l;
            int i;
            switch (elements.length)
            {
                case 1:
                    l = Long.parseLong(elements[0]);
                    if ((l < 0L) || (l > 4294967295L)){
                        return null;
                    }
                    bytes[0] = (byte) (int) (l >> 24 & 0xFF);
                    bytes[1] = (byte) (int) ((l & 0xFFFFFF) >> 16 & 0xFF);
                    bytes[2] = (byte) (int) ((l & 0xFFFF) >> 8 & 0xFF);
                    bytes[3] = (byte) (int) (l & 0xFF);
                    break;
                case 2:
                    l = Integer.parseInt(elements[0]);
                    if ((l < 0L) || (l > 255L)){
                        return null;
                    }
                    bytes[0] = (byte) (int) (l & 0xFF);
                    l = Integer.parseInt(elements[1]);
                    if ((l < 0L) || (l > 16777215L)){
                        return null;
                    }
                    bytes[1] = (byte) (int) (l >> 16 & 0xFF);
                    bytes[2] = (byte) (int) ((l & 0xFFFF) >> 8 & 0xFF);
                    bytes[3] = (byte) (int) (l & 0xFF);
                    break;
                case 3:
                    for (i = 0; i < 2; ++i)
                    {
                        l = Integer.parseInt(elements[i]);
                        if ((l < 0L) || (l > 255L)){
                            return null;
                        }
                        bytes[i] = (byte) (int) (l & 0xFF);
                    }
                    l = Integer.parseInt(elements[2]);
                    if ((l < 0L) || (l > 65535L)){
                        return null;
                    }
                    bytes[2] = (byte) (int) (l >> 8 & 0xFF);
                    bytes[3] = (byte) (int) (l & 0xFF);
                    break;
                case 4:
                    for (i = 0; i < 4; ++i)
                    {
                        l = Integer.parseInt(elements[i]);
                        if ((l < 0L) || (l > 255L)){
                            return null;
                        }
                        bytes[i] = (byte) (int) (l & 0xFF);
                    }
                    break;
                default:
                    return null;
            }
        }
        catch (NumberFormatException e)
        {
            return null;
        }
        return bytes;
    }

    public static String getHostIp()
    {
        try
        {
            return InetAddress.getLocalHost().getHostAddress();
        }
        catch (UnknownHostException e)
        {
        }
        return "127.0.0.1";
    }

    public static String getHostName()
    {
        try
        {
            return InetAddress.getLocalHost().getHostName();
        }
        catch (UnknownHostException e)
        {
        }
        return "未知";
    }
}

總結

到此這篇關於Java如何提供給第三方使用介面方法的文章就介紹到這了,更多相關Java提供介面給第三方使用內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com