Browse Source

编码注释完善

fushengqian 1 year ago
parent
commit
830e95f206

+ 5 - 0
fuint-application/src/main/java/com/fuint/common/service/RefundService.java

@@ -75,6 +75,7 @@ public interface RefundService extends IService<MtRefund> {
 
 
     /**
     /**
      * 发起退款
      * 发起退款
+     *
      * @param orderId
      * @param orderId
      * @param refundAmount
      * @param refundAmount
      * @param remark
      * @param remark
@@ -85,6 +86,10 @@ public interface RefundService extends IService<MtRefund> {
 
 
     /**
     /**
      * 获取售后订单总数
      * 获取售后订单总数
+     *
+     * @param beginTime
+     * @param endTime
+     * @return
      * */
      * */
     Long getRefundCount(Date beginTime, Date endTime) throws BusinessCheckException;
     Long getRefundCount(Date beginTime, Date endTime) throws BusinessCheckException;
 }
 }

+ 1 - 0
fuint-application/src/main/java/com/fuint/common/service/SendLogService.java

@@ -45,6 +45,7 @@ public interface SendLogService extends IService<MtSendLog> {
      * @param  id       ID
      * @param  id       ID
      * @param  operator 操作人
      * @param  operator 操作人
      * @throws BusinessCheckException
      * @throws BusinessCheckException
+     * @return
      */
      */
     void deleteSendLog(Long id, String operator) throws BusinessCheckException;
     void deleteSendLog(Long id, String operator) throws BusinessCheckException;
 }
 }

+ 2 - 0
fuint-application/src/main/java/com/fuint/common/service/SettingService.java

@@ -50,12 +50,14 @@ public interface SettingService extends IService<MtSetting> {
 
 
     /**
     /**
      * 获取系统上传文件的根路径
      * 获取系统上传文件的根路径
+     *
      * @return 本地配置或阿里云的oss域名
      * @return 本地配置或阿里云的oss域名
      * */
      * */
     String getUploadBasePath();
     String getUploadBasePath();
 
 
     /**
     /**
      * 获取支付方式列表
      * 获取支付方式列表
+     *
      * @param platform 平台
      * @param platform 平台
      * @return
      * @return
      * */
      * */

+ 2 - 1
fuint-application/src/main/java/com/fuint/common/service/SettlementService.java

@@ -28,6 +28,7 @@ public interface SettlementService {
      *
      *
      * @param  requestParam
      * @param  requestParam
      * @throws BusinessCheckException
      * @throws BusinessCheckException
+     * @return
      */
      */
     Boolean submitSettlement(SettlementRequest requestParam) throws BusinessCheckException;
     Boolean submitSettlement(SettlementRequest requestParam) throws BusinessCheckException;
 
 
@@ -37,6 +38,7 @@ public interface SettlementService {
      * @param  settlementId
      * @param  settlementId
      * @param  operator
      * @param  operator
      * @throws BusinessCheckException
      * @throws BusinessCheckException
+     * @return
      */
      */
     Boolean doConfirm(Integer settlementId, String operator) throws BusinessCheckException;
     Boolean doConfirm(Integer settlementId, String operator) throws BusinessCheckException;
 
 
@@ -46,7 +48,6 @@ public interface SettlementService {
      * @param settlementId
      * @param settlementId
      * @param page
      * @param page
      * @param pageSize
      * @param pageSize
-     *
      * @return
      * @return
      * */
      * */
     SettlementDto getSettlementInfo(Integer settlementId, Integer page, Integer pageSize) throws BusinessCheckException;
     SettlementDto getSettlementInfo(Integer settlementId, Integer page, Integer pageSize) throws BusinessCheckException;

+ 2 - 0
fuint-application/src/main/java/com/fuint/common/service/StaffService.java

@@ -60,6 +60,7 @@ public interface StaffService extends IService<MtStaff> {
      *
      *
      * @param  mobile 手机
      * @param  mobile 手机
      * @throws BusinessCheckException
      * @throws BusinessCheckException
+     * @return
      */
      */
     MtStaff queryStaffByMobile(String mobile) throws BusinessCheckException;
     MtStaff queryStaffByMobile(String mobile) throws BusinessCheckException;
 
 
@@ -68,6 +69,7 @@ public interface StaffService extends IService<MtStaff> {
      *
      *
      * @param userId 会员ID
      * @param userId 会员ID
      * @throws BusinessCheckException
      * @throws BusinessCheckException
+     * @return
      */
      */
     MtStaff queryStaffByUserId(Integer userId) throws BusinessCheckException;
     MtStaff queryStaffByUserId(Integer userId) throws BusinessCheckException;
 }
 }

+ 2 - 0
fuint-application/src/main/java/com/fuint/common/service/StockService.java

@@ -51,6 +51,7 @@ public interface StockService extends IService<MtStock> {
      *
      *
      * @param  id ID
      * @param  id ID
      * @throws BusinessCheckException
      * @throws BusinessCheckException
+     * @return
      */
      */
     MtStock queryStockById(Long id) throws BusinessCheckException;
     MtStock queryStockById(Long id) throws BusinessCheckException;
 
 
@@ -59,6 +60,7 @@ public interface StockService extends IService<MtStock> {
      *
      *
      * @param  params
      * @param  params
      * @throws BusinessCheckException
      * @throws BusinessCheckException
+     * @return
      * */
      * */
     List<MtStockItem> queryItemByParams(Map<String, Object> params) throws BusinessCheckException;
     List<MtStockItem> queryItemByParams(Map<String, Object> params) throws BusinessCheckException;
 }
 }

+ 60 - 1
fuint-application/src/main/java/com/fuint/common/service/WeixinService.java

@@ -19,20 +19,79 @@ import java.util.Date;
  */
  */
 public interface WeixinService {
 public interface WeixinService {
 
 
+    /**
+     * 获取微信登录token
+     *
+     * @param merchantId 商户ID
+     * @param useCache 是否从缓存中读取
+     * @return
+     * */
     String getAccessToken(Integer merchantId, boolean useCache) throws BusinessCheckException ;
     String getAccessToken(Integer merchantId, boolean useCache) throws BusinessCheckException ;
 
 
+    /**
+     * 提交预支付订单
+     *
+     * @param userInfo 会员信息
+     * @param orderInfo 订单信息
+     * @param payAmount 支付金额
+     * @param authCode 支付二维码
+     * @param giveAmount 赠送金额
+     * @param ip 支付发起IP
+     * @param platform 支付平台
+     * @return
+     * */
     ResponseObject createPrepayOrder(MtUser userInfo, MtOrder orderInfo, Integer payAmount, String authCode, Integer giveAmount, String ip, String platform) throws BusinessCheckException;
     ResponseObject createPrepayOrder(MtUser userInfo, MtOrder orderInfo, Integer payAmount, String authCode, Integer giveAmount, String ip, String platform) throws BusinessCheckException;
 
 
+    /**
+     * 处理返回的xml数据
+     *
+     * @param request 请求体
+     * @return
+     * */
     Map<String,String> processResXml(HttpServletRequest request);
     Map<String,String> processResXml(HttpServletRequest request);
 
 
+    /**
+     * 处理返回的xml数据
+     *
+     * @param response 返回相应
+     * @param flag 标签
+     * @return
+     * */
     void processRespXml(HttpServletResponse response, boolean flag);
     void processRespXml(HttpServletResponse response, boolean flag);
 
 
+    /**
+     * 获取微信个人信息
+     *
+     * @param merchantId 商户ID
+     * @param code 登录编码
+     * @return
+     * */
     JSONObject getWxProfile(Integer merchantId, String code) throws BusinessCheckException;
     JSONObject getWxProfile(Integer merchantId, String code) throws BusinessCheckException;
 
 
+    /**
+     * 获取微信openId
+     *
+     * @param merchantId 商户ID
+     * @param code 登录编码
+     * @return
+     * */
     JSONObject getWxOpenId(Integer merchantId, String code) throws BusinessCheckException;
     JSONObject getWxOpenId(Integer merchantId, String code) throws BusinessCheckException;
 
 
-    String getPhoneNumber(String encryptedData, String session_key, String iv);
+    /**
+     * 获取会员微信绑定的手机号
+     *
+     * @param encryptedData 加密的编码(前端返回)
+     * @param sessionKey
+     * @param iv
+     * @return
+     * */
+    String getPhoneNumber(String encryptedData, String sessionKey, String iv);
 
 
+    /**
+     * 发送订阅消息
+     *
+     * @param merchantId 
+     * */
     Boolean sendSubscribeMessage(Integer merchantId, Integer userId, String toUserOpenId, String key, String page, Map<String,Object> params, Date sendTime) throws BusinessCheckException;
     Boolean sendSubscribeMessage(Integer merchantId, Integer userId, String toUserOpenId, String key, String page, Map<String,Object> params, Date sendTime) throws BusinessCheckException;
 
 
     Boolean doSendSubscribeMessage(Integer merchantId, String reqDataJsonStr);
     Boolean doSendSubscribeMessage(Integer merchantId, String reqDataJsonStr);