API 接口應(yīng)該如何設(shè)計技竟?如何保證安全巷疼?如何簽名?如何防重灵奖?

來源:https://www.cnblogs.com/jurendage/p/12653865.html
作者:巨人大哥

說明:在實(shí)際的業(yè)務(wù)中,難免會跟第三方系統(tǒng)進(jìn)行數(shù)據(jù)的交互與傳遞估盘,那么如何保證數(shù)據(jù)在傳輸過程中的安全呢(防竊却苫肌)?除了https的協(xié)議之外遣妥,能不能加上通用的一套算法以及規(guī)范來保證傳輸?shù)陌踩阅兀?/p>

下面我們就來討論下常用的一些API設(shè)計的安全方法擅编,可能不一定是最好的,有更牛逼的實(shí)現(xiàn)方式箫踩,但是這篇是我自己的經(jīng)驗分享.

token 簡介

Token:訪問令牌access token, 用于接口中,
用于標(biāo)識接口調(diào)用者的身份爱态、憑證慨削,減少用戶名和密碼的傳輸次數(shù)洞渔。一般情況下客戶端(接口調(diào)用方)需要先向服務(wù)器端申請一個接口調(diào)用的賬號套媚,服務(wù)器會給出一個appId和一個key,
key用于參數(shù)簽名使用,注意key保存到客戶端磁椒,需要做一些安全處理堤瘤,防止泄露。

Token的值一般是UUID浆熔,服務(wù)端生成Token后需要將token做為key医增,將一些和token關(guān)聯(lián)的信息作為value保存到緩存服務(wù)器中(redis)慎皱,當(dāng)一個請求過來后,服務(wù)器就去緩存服務(wù)器中查詢這個Token是否存在调窍,存在則調(diào)用接口地梨,不存在返回接口錯誤,一般通過攔截器或者過濾器來實(shí)現(xiàn)缔恳,Token分為兩種:

API Token(接口令牌): 用于訪問不需要用戶登錄的接口宝剖,如登錄、注冊歉甚、一些基本數(shù)據(jù)的獲取等万细。獲取接口令牌需要拿appId、timestamp和sign來換纸泄,sign=加密(timestamp+key)
USER Token(用戶令牌): 用于訪問需要用戶登錄之后的接口赖钞,如:獲取我的基本信息、保存聘裁、修改雪营、刪除等操作。獲取用戶令牌需要拿用戶名和密碼來換
關(guān)于Token的時效性:token可以是一次性的衡便、也可以在一段時間范圍內(nèi)是有效的献起,具體使用哪種看業(yè)務(wù)需要。

一般情況下接口最好使用https協(xié)議镣陕,如果使用http協(xié)議谴餐,Token機(jī)制只是一種減少被黑的可能性,其實(shí)只能防君子不能防小人呆抑。

一般token岂嗓、timestamp和sign 三個參數(shù)會在接口中會同時作為參數(shù)傳遞,每個參數(shù)都有各自的用途鹊碍。

timestamp 簡介

timestamp:
時間戳摄闸,是客戶端調(diào)用接口時對應(yīng)的當(dāng)前時間戳善镰,時間戳用于防止DoS攻擊。當(dāng)黑客劫持了請求的url去DoS攻擊年枕,每次調(diào)用接口時接口都會判斷服務(wù)器當(dāng)前系統(tǒng)時間和接口中傳的的timestamp的差值炫欺,如果這個差值超過某個設(shè)置的時間(假如5分鐘),那么這個請求將被攔截掉熏兄,如果在設(shè)置的超時時間范圍內(nèi)品洛,是不能阻止DoS攻擊的。
timestamp機(jī)制只能減輕DoS攻擊的時間摩桶,縮短攻擊時間桥状。如果黑客修改了時間戳的值可通過sign簽名機(jī)制來處理。

DoS

DoS是Denial of
Service的簡稱硝清,即拒絕服務(wù)辅斟,造成DoS的攻擊行為被稱為DoS攻擊,其目的是使計算機(jī)或網(wǎng)絡(luò)無法提供正常的服務(wù)芦拿。最常見的DoS攻擊有計算機(jī)網(wǎng)絡(luò)帶寬攻擊和連通性攻擊士飒。

DoS攻擊是指故意的攻擊網(wǎng)絡(luò)協(xié)議實(shí)現(xiàn)的缺陷或直接通過野蠻手段殘忍地耗盡被攻擊對象的資源,目的是讓目標(biāo)計算機(jī)或網(wǎng)絡(luò)無法提供正常的服務(wù)或資源訪問蔗崎,使目標(biāo)系統(tǒng)服務(wù)系統(tǒng)停止響應(yīng)甚至崩潰酵幕,而在此攻擊中并不包括侵入目標(biāo)服務(wù)器或目標(biāo)網(wǎng)絡(luò)設(shè)備。這些服務(wù)資源包括網(wǎng)絡(luò)帶寬缓苛,文件系統(tǒng)空間容量芳撒,開放的進(jìn)程或者允許的連接。這種攻擊會導(dǎo)致資源的匱乏未桥,無論計算機(jī)的處理速度多快笔刹、內(nèi)存容量多大、網(wǎng)絡(luò)帶寬的速度多快都無法避免這種攻擊帶來的后果冬耿。

Pingflood: 該攻擊在短時間內(nèi)向目的主機(jī)發(fā)送大量ping包徘熔,造成網(wǎng)絡(luò)堵塞或主機(jī)資源耗盡。
Synflood: 該攻擊以多個隨機(jī)的源主機(jī)地址向目的主機(jī)發(fā)送SYN包淆党,而在收到目的主機(jī)的SYN ACK后并不回應(yīng),這樣讶凉,目的主機(jī)就為這些源主機(jī)建立了大量的連接隊列染乌,而且由于沒有收到ACK一直維護(hù)著這
些隊列,造成了資源的大量消耗而不能向正常請求提供服務(wù)懂讯。

Smurf:該攻擊向一個子網(wǎng)的廣播地址發(fā)一個帶有特定請求(如ICMP回應(yīng)請求)的包荷憋,并且將源地址偽裝成想要攻擊的主機(jī)地址。子網(wǎng)上所有主機(jī)都回應(yīng)廣播包請求而向被攻擊主機(jī)發(fā)包褐望,使該主機(jī)受到攻擊勒庄。
Land-based:攻擊者將一個包的源地址和目的地址都設(shè)置為目標(biāo)主機(jī)的地址串前,然后將該包通過IP欺騙的方式發(fā)送給被攻擊主機(jī),這種包可以造成被攻擊主機(jī)因試圖與自己建立連接而陷入死循環(huán)实蔽,從而很大程度地降低了系統(tǒng)性能荡碾。
Ping of Death:根據(jù)TCP/IP的規(guī)范,一個包的長度最大為65536字節(jié)局装。盡管一個包的長度不能超過65536字節(jié)坛吁,但是一個包分成的多個片段的疊加卻能做到。當(dāng)一個主機(jī)收到了長度大于65536字節(jié)的包時铐尚,就是受到了Ping of Death攻擊拨脉,該攻擊會造成主機(jī)的宕機(jī)。
Teardrop:IP數(shù)據(jù)包在網(wǎng)絡(luò)傳遞時宣增,數(shù)據(jù)包可以分成更小的片段玫膀。攻擊者可以通過發(fā)送兩段(或者更多)數(shù)據(jù)包來實(shí)現(xiàn)TearDrop攻擊。第一個包的偏移量為0爹脾,長度為N帖旨,第二個包的偏移量小于N。為了合并這些數(shù)據(jù)段誉简,TCP/IP堆棧會分配超乎尋常的巨大資源碉就,從而造成系統(tǒng)資源的缺乏甚至機(jī)器的重新啟動。
PingSweep:使用ICMP Echo輪詢多個主機(jī)闷串。
sign 簡介

nonce:隨機(jī)值瓮钥,是客戶端隨機(jī)生成的值,作為參數(shù)傳遞過來烹吵,隨機(jī)值的目的是增加sign簽名的多變性碉熄。隨機(jī)值一般是數(shù)字和字母的組合,6位長度肋拔,隨機(jī)值的組成和長度沒有固定規(guī)則锈津。

sign: 一般用于參數(shù)簽名,防止參數(shù)被非法篡改凉蜂,最常見的是修改金額等重要敏感參數(shù)琼梆,
sign的值一般是將所有非空參數(shù)按照升續(xù)排序然后+token+key+timestamp+nonce(隨機(jī)數(shù))拼接在一起,然后使用某種加密算法進(jìn)行加密窿吩,作為接口中的一個參數(shù)sign來傳遞茎杂,也可以將sign放到請求頭中。接口在網(wǎng)絡(luò)傳輸過程中如果被黑客挾持纫雁,并修改其中的參數(shù)值煌往,然后再繼續(xù)調(diào)用接口,雖然參數(shù)的值被修改了轧邪,但是因為黑客不知道sign是如何計算出來的刽脖,不知道sign都有哪些值構(gòu)成羞海,不知道以怎樣的順序拼接在一起的,最重要的是不知道簽名字符串中的key是什么曲管,所以黑客可以篡改參數(shù)的值却邓,但沒法修改sign的值,當(dāng)服務(wù)器調(diào)用接口前會按照sign的規(guī)則重新計算出sign的值然后和接口傳遞的sign參數(shù)的值做比較翘地,如果相等表示參數(shù)值沒有被篡改申尤,如果不等,表示參數(shù)被非法篡改了衙耕,就不執(zhí)行接口了昧穿。

防止重復(fù)提交

對于一些重要的操作需要防止客戶端重復(fù)提交的(如非冪等性重要操作),具體辦法是當(dāng)請求第一次提交時將sign作為key保存到redis橙喘,并設(shè)置超時時間时鸵,超時時間和Timestamp中設(shè)置的差值相同。當(dāng)同一個請求第二次訪問時會先檢測redis是否存在該sign厅瞎,如果存在則證明重復(fù)提交了饰潜,接口就不再繼續(xù)調(diào)用了。如果sign在緩存服務(wù)器中因過期時間到了和簸,而被刪除了彭雾,此時當(dāng)這個url再次請求服務(wù)器時,因token的過期時間和sign的過期時間一直锁保,sign過期也意味著token過期薯酝,那樣同樣的url再訪問服務(wù)器會因token錯誤會被攔截掉,這就是為什么sign和token的過期時間要保持一致的原因爽柒。拒絕重復(fù)調(diào)用機(jī)制確保URL被別人截獲了也無法使用(如抓取數(shù)據(jù))吴菠。

對于哪些接口需要防止重復(fù)提交可以自定義個注解來標(biāo)記。

注意:所有的安全措施都用上的話有時候難免太過復(fù)雜浩村,在實(shí)際項目中需要根據(jù)自身情況作出裁剪做葵,比如可以只使用簽名機(jī)制就可以保證信息不會被篡改,或者定向提供服務(wù)的時候只用Token機(jī)制就可以了心墅。如何裁剪酿矢,全看項目實(shí)際情況和對接口安全性的要求。
使用流程

接口調(diào)用方(客戶端)向接口提供方(服務(wù)器)申請接口調(diào)用賬號怎燥,申請成功后瘫筐,接口提供方會給接口調(diào)用方一個appId和一個key參數(shù)
客戶端攜帶參數(shù)appId、timestamp刺覆、sign去調(diào)用服務(wù)器端的API token,其中sign=加密(appId + timestamp + key)
客戶端拿著api_token 去訪問不需要登錄就能訪問的接口
當(dāng)訪問用戶需要登錄的接口時史煎,客戶端跳轉(zhuǎn)到登錄頁面谦屑,通過用戶名和密碼調(diào)用登錄接口驳糯,登錄接口會返回一個usertoken, 客戶端拿著usertoken 去訪問需要登錄才能訪問的接口
sign的作用是防止參數(shù)被篡改,客戶端調(diào)用服務(wù)端時需要傳遞sign參數(shù)氢橙,服務(wù)器響應(yīng)客戶端時也可以返回一個sign用于客戶度校驗返回的值是否被非法篡改了酝枢。客戶端傳的sign和服務(wù)器端響應(yīng)的sign算法可能會不同悍手。

示例代碼

dependency

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>2.9.0</version>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

RedisConfiguration

@Configuration
public class RedisConfiguration {
    @Bean
    public JedisConnectionFactory jedisConnectionFactory(){
        return new JedisConnectionFactory();
    }

    /**
     * 支持存儲對象
     * @return
     */
    @Bean
    public RedisTemplate<String, String> redisTemplate(){
        RedisTemplate<String, String> redisTemplate = new StringRedisTemplate();
        redisTemplate.setConnectionFactory(jedisConnectionFactory());
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);

        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
        redisTemplate.afterPropertiesSet();

        return redisTemplate;
    }
}

TokenController

@Slf4j
@RestController
@RequestMapping("/api/token")
public class TokenController {

    @Autowired
    private RedisTemplate redisTemplate;

    /**
     * API Token
     *
     * @param sign
     * @return
     */
    @PostMapping("/api_token")
    public ApiResponse<AccessToken> apiToken(String appId, @RequestHeader("timestamp") String timestamp, @RequestHeader("sign") String sign) {
        Assert.isTrue(!StringUtils.isEmpty(appId) && !StringUtils.isEmpty(timestamp) && !StringUtils.isEmpty(sign), "參數(shù)錯誤");

        long reqeustInterval = System.currentTimeMillis() - Long.valueOf(timestamp);
        Assert.isTrue(reqeustInterval < 5 * 60 * 1000, "請求過期帘睦,請重新請求");

        // 1. 根據(jù)appId查詢數(shù)據(jù)庫獲取appSecret
        AppInfo appInfo = new AppInfo("1", "12345678954556");

        // 2. 校驗簽名
        String signString = timestamp + appId + appInfo.getKey();
        String signature = MD5Util.encode(signString);
        log.info(signature);
        Assert.isTrue(signature.equals(sign), "簽名錯誤");

        // 3. 如果正確生成一個token保存到redis中,如果錯誤返回錯誤信息
        AccessToken accessToken = this.saveToken(0, appInfo, null);

        return ApiResponse.success(accessToken);
    }


    @NotRepeatSubmit(5000)
    @PostMapping("user_token")
    public ApiResponse<UserInfo> userToken(String username, String password) {
        // 根據(jù)用戶名查詢密碼, 并比較密碼(密碼可以RSA加密一下)
        UserInfo userInfo = new UserInfo(username, "81255cb0dca1a5f304328a70ac85dcbd", "111111");
        String pwd = password + userInfo.getSalt();
        String passwordMD5 = MD5Util.encode(pwd);
        Assert.isTrue(passwordMD5.equals(userInfo.getPassword()), "密碼錯誤");

        // 2. 保存Token
        AppInfo appInfo = new AppInfo("1", "12345678954556");
        AccessToken accessToken = this.saveToken(1, appInfo, userInfo);
        userInfo.setAccessToken(accessToken);
        return ApiResponse.success(userInfo);
    }

    private AccessToken saveToken(int tokenType, AppInfo appInfo,  UserInfo userInfo) {
        String token = UUID.randomUUID().toString();

        // token有效期為2小時
        Calendar calendar = Calendar.getInstance();
        calendar.setTime(new Date());
        calendar.add(Calendar.SECOND, 7200);
        Date expireTime = calendar.getTime();

        // 4. 保存token
        ValueOperations<String, TokenInfo> operations = redisTemplate.opsForValue();
        TokenInfo tokenInfo = new TokenInfo();
        tokenInfo.setTokenType(tokenType);
        tokenInfo.setAppInfo(appInfo);

        if (tokenType == 1) {
            tokenInfo.setUserInfo(userInfo);
        }

        operations.set(token, tokenInfo, 7200, TimeUnit.SECONDS);

        AccessToken accessToken = new AccessToken(token, expireTime);

        return accessToken;
    }

    public static void main(String[] args) {
        long timestamp = System.currentTimeMillis();
        System.out.println(timestamp);
        String signString = timestamp + "1" + "12345678954556";
        String sign = MD5Util.encode(signString);
        System.out.println(sign);

        System.out.println("-------------------");
        signString = "password=123456&username=1&12345678954556" + "ff03e64b-427b-45a7-b78b-47d9e8597d3b1529815393153sdfsdfsfs" + timestamp + "A1scr6";
        sign = MD5Util.encode(signString);
        System.out.println(sign);
    }
}

WebMvcConfiguration

@Configuration
public class WebMvcConfiguration extends WebMvcConfigurationSupport {

    private static final String[] excludePathPatterns  = {"/api/token/api_token"};

    @Autowired
    private TokenInterceptor tokenInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        super.addInterceptors(registry);
        registry.addInterceptor(tokenInterceptor)
                .addPathPatterns("/api/**")
                .excludePathPatterns(excludePathPatterns);
    }
}
5. TokenInterceptor
@Component
public class TokenInterceptor extends HandlerInterceptorAdapter {

    @Autowired
    private RedisTemplate redisTemplate;

    /**
     *
     * @param request
     * @param response
     * @param handler 訪問的目標(biāo)方法
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String token = request.getHeader("token");
        String timestamp = request.getHeader("timestamp");
        // 隨機(jī)字符串
        String nonce = request.getHeader("nonce");
        String sign = request.getHeader("sign");
        Assert.isTrue(!StringUtils.isEmpty(token) && !StringUtils.isEmpty(timestamp) && !StringUtils.isEmpty(sign), "參數(shù)錯誤");

        // 獲取超時時間
        NotRepeatSubmit notRepeatSubmit = ApiUtil.getNotRepeatSubmit(handler);
        long expireTime = notRepeatSubmit == null ? 5 * 60 * 1000 : notRepeatSubmit.value();

        // 2. 請求時間間隔
        long reqeustInterval = System.currentTimeMillis() - Long.valueOf(timestamp);
        Assert.isTrue(reqeustInterval < expireTime, "請求超時坦康,請重新請求");

        // 3. 校驗Token是否存在
        ValueOperations<String, TokenInfo> tokenRedis = redisTemplate.opsForValue();
        TokenInfo tokenInfo = tokenRedis.get(token);
        Assert.notNull(tokenInfo, "token錯誤");

        // 4. 校驗簽名(將所有的參數(shù)加進(jìn)來竣付,防止別人篡改參數(shù)) 所有參數(shù)看參數(shù)名升續(xù)排序拼接成url
        // 請求參數(shù) + token + timestamp + nonce
        String signString = ApiUtil.concatSignString(request) + tokenInfo.getAppInfo().getKey() + token + timestamp + nonce;
        String signature = MD5Util.encode(signString);
        boolean flag = signature.equals(sign);
        Assert.isTrue(flag, "簽名錯誤");

        // 5. 拒絕重復(fù)調(diào)用(第一次訪問時存儲,過期時間和請求超時時間保持一致), 只有標(biāo)注不允許重復(fù)提交注解的才會校驗
        if (notRepeatSubmit != null) {
            ValueOperations<String, Integer> signRedis = redisTemplate.opsForValue();
            boolean exists = redisTemplate.hasKey(sign);
            Assert.isTrue(!exists, "請勿重復(fù)提交");
            signRedis.set(sign, 0, expireTime, TimeUnit.MILLISECONDS);
        }

        return super.preHandle(request, response, handler);
    }
}

MD5Util ----MD5工具類滞欠,加密生成數(shù)字簽名

public class MD5Util {

    private static final String hexDigits[] = { "0", "1", "2", "3", "4", "5",
            "6", "7", "8", "9", "a", "b", "c", "d", "e", "f" };

    private static String byteArrayToHexString(byte b[]) {
        StringBuffer resultSb = new StringBuffer();
        for (int i = 0; i < b.length; i++)
            resultSb.append(byteToHexString(b[i]));

        return resultSb.toString();
    }

    private static String byteToHexString(byte b) {
        int n = b;
        if (n < 0)
            n += 256;
        int d1 = n / 16;
        int d2 = n % 16;
        return hexDigits[d1] + hexDigits[d2];
    }

    public static String encode(String origin) {
        return encode(origin, "UTF-8");
    }
    public static String encode(String origin, String charsetname) {
        String resultString = null;
        try {
            resultString = new String(origin);
            MessageDigest md = MessageDigest.getInstance("MD5");
            if (charsetname == null || "".equals(charsetname))
                resultString = byteArrayToHexString(md.digest(resultString
                        .getBytes()));
            else
                resultString = byteArrayToHexString(md.digest(resultString
                        .getBytes(charsetname)));
        } catch (Exception exception) {
        }
        return resultString;
    }
}

@NotRepeatSubmit -----自定義注解古胆,防止重復(fù)提交。

/**
 * 禁止重復(fù)提交
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface NotRepeatSubmit {
    /** 過期時間筛璧,單位毫秒 **/
    long value() default 5000;
}

AccessToken

@Data
@AllArgsConstructor
public class AccessToken {
    /** token */
    private String token;

    /** 失效時間 */
    private Date expireTime;
}

AppInfo

@Data
@NoArgsConstructor
@AllArgsConstructor
public class AppInfo {
    /** App id */
    private String appId;
    /** API 秘鑰 */
    private String key;
}

TokenInfo

@Data
public class TokenInfo {
    /** token類型: api:0 逸绎、user:1 */
    private Integer tokenType;

    /** App 信息 */
    private AppInfo appInfo;

    /** 用戶其他數(shù)據(jù) */
    private UserInfo userInfo;
}

UserInfo

@Data
public class UserInfo {
    /** 用戶名 */
    private String username;
    /** 手機(jī)號 */
    private String mobile;
    /** 郵箱 */
    private String email;
    /** 密碼 */
    private String password;
    /** 鹽 */
    private String salt;

    private AccessToken accessToken;

    public UserInfo(String username, String password, String salt) {
        this.username = username;
        this.password = password;
        this.salt = salt;
    }
}

ApiCodeEnum

/**
 * 錯誤碼code可以使用純數(shù)字,使用不同區(qū)間標(biāo)識一類錯誤,也可以使用純字符夭谤,也可以使用前綴+編號
 *
 * 錯誤碼:ERR + 編號
 *
 * 可以使用日志級別的前綴作為錯誤類型區(qū)分 Info(I) Error(E) Warning(W)
 *
 * 或者以業(yè)務(wù)模塊 + 錯誤號
 *
 * TODO 錯誤碼設(shè)計
 *
 * Alipay 用了兩個code棺牧,兩個msg(https://docs.open.alipay.com/api_1/alipay.trade.pay)
 */
public enum ApiCodeEnum {
    SUCCESS("10000", "success"),
    UNKNOW_ERROR("ERR0001","未知錯誤"),
    PARAMETER_ERROR("ERR0002","參數(shù)錯誤"),
    TOKEN_EXPIRE("ERR0003","認(rèn)證過期"),
    REQUEST_TIMEOUT("ERR0004","請求超時"),
    SIGN_ERROR("ERR0005","簽名錯誤"),
    REPEAT_SUBMIT("ERR0006","請不要頻繁操作"),
    ;

    /** 代碼 */
    private String code;

    /** 結(jié)果 */
    private String msg;

    ApiCodeEnum(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public String getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }
}

ApiResult

@Data
@NoArgsConstructor
@AllArgsConstructor
public class ApiResult {

    /** 代碼 */
    private String code;

    /** 結(jié)果 */
    private String msg;
}

ApiUtil -------這個參考支付寶加密的算法寫的.我直接Copy過來了。

public class ApiUtil {

    /**
     * 按參數(shù)名升續(xù)拼接參數(shù)
     * @param request
     * @return
     */
    public static String concatSignString(HttpServletRequest request) {
        Map<String, String> paramterMap = new HashMap<>();
        request.getParameterMap().forEach((key, value) -> paramterMap.put(key, value[0]));
        // 按照key升續(xù)排序朗儒,然后拼接參數(shù)
        Set<String> keySet = paramterMap.keySet();
        String[] keyArray = keySet.toArray(new String[keySet.size()]);
        Arrays.sort(keyArray);
        StringBuilder sb = new StringBuilder();
        for (String k : keyArray) {
            // 或略掉的字段
            if (k.equals("sign")) {
                continue;
            }
            if (paramterMap.get(k).trim().length() > 0) {
                // 參數(shù)值為空颊乘,則不參與簽名
                sb.append(k).append("=").append(paramterMap.get(k).trim()).append("&");
            }
        }

        return sb.toString();
    }

    public static String concatSignString(Map<String, String> map) {
        Map<String, String> paramterMap = new HashMap<>();
        map.forEach((key, value) -> paramterMap.put(key, value));
        // 按照key升續(xù)排序,然后拼接參數(shù)
        Set<String> keySet = paramterMap.keySet();
        String[] keyArray = keySet.toArray(new String[keySet.size()]);
        Arrays.sort(keyArray);
        StringBuilder sb = new StringBuilder();
        for (String k : keyArray) {
            if (paramterMap.get(k).trim().length() > 0) {
                // 參數(shù)值為空采蚀,則不參與簽名
                sb.append(k).append("=").append(paramterMap.get(k).trim()).append("&");
            }
        }
        return sb.toString();
    }

    /**
     * 獲取方法上的@NotRepeatSubmit注解
     * @param handler
     * @return
     */
    public static NotRepeatSubmit getNotRepeatSubmit(Object handler) {
        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            Method method = handlerMethod.getMethod();
            NotRepeatSubmit annotation = method.getAnnotation(NotRepeatSubmit.class);

            return annotation;
        }

        return null;
    }
}

ApiResponse

@Data
@Slf4j
public class ApiResponse<T> {
    /** 結(jié)果 */
    private ApiResult result;

    /** 數(shù)據(jù) */
    private T data;

    /** 簽名 */
    private String sign;


    public static <T> ApiResponse success(T data) {
        return response(ApiCodeEnum.SUCCESS.getCode(), ApiCodeEnum.SUCCESS.getMsg(), data);
    }

    public static ApiResponse error(String code, String msg) {
        return response(code, msg, null);
    }

    public static <T> ApiResponse response(String code, String msg, T data) {
        ApiResult result = new ApiResult(code, msg);
        ApiResponse response = new ApiResponse();
        response.setResult(result);
        response.setData(data);

        String sign = signData(data);
        response.setSign(sign);

        return response;
    }

    private static <T> String signData(T data) {
        // TODO 查詢key
        String key = "12345678954556";
        Map<String, String> responseMap = null;
        try {
            responseMap = getFields(data);
        } catch (IllegalAccessException e) {
            return null;
        }
        String urlComponent = ApiUtil.concatSignString(responseMap);
        String signature = urlComponent + "key=" + key;
        String sign = MD5Util.encode(signature);

        return sign;
    }

    /**
     * @param data 反射的對象,獲取對象的字段名和值
     * @throws IllegalArgumentException
     * @throws IllegalAccessException
     */
    public static Map<String, String> getFields(Object data) throws IllegalAccessException, IllegalArgumentException {
        if (data == null) return null;
        Map<String, String> map = new HashMap<>();
        Field[] fields = data.getClass().getDeclaredFields();
        for (int i = 0; i < fields.length; i++) {
            Field field = fields[i];
            field.setAccessible(true);

            String name = field.getName();
            Object value = field.get(data);
            if (field.get(data) != null) {
                map.put(name, value.toString());
            }
        }

        return map;
    }
}

ThreadLocal

ThreadLocal是線程內(nèi)的全局上下文疲牵。就是在單個線程中,方法之間共享的內(nèi)存榆鼠,每個方法都可以從該上下文中獲取值和修改值纲爸。

實(shí)際案例:

在調(diào)用api時都會傳一個token參數(shù),通常會寫一個攔截器來校驗token是否合法妆够,我們可以通過token找到對應(yīng)的用戶信息(User)识啦,如果token合法,然后將用戶信息存儲到ThreadLocal中神妹,這樣無論是在controller颓哮、service、dao的哪一層都能訪問到該用戶的信息鸵荠。作用類似于Web中的request作用域冕茅。

傳統(tǒng)方式我們要在方法中訪問某個變量,可以通過傳參的形式往方法中傳參,如果多個方法都要使用那么每個方法都要傳參姨伤;如果使用ThreadLocal所有方法就不需要傳該參數(shù)了哨坪,每個方法都可以通過ThreadLocal來訪問該值。

ThreadLocalUtil.set("key", value); 保存值
T value = ThreadLocalUtil.get("key"); 獲取值
ThreadLocalUtil

public class ThreadLocalUtil<T> {
    private static final ThreadLocal<Map<String, Object>> threadLocal = new ThreadLocal() {
        @Override
        protected Map<String, Object> initialValue() {
            return new HashMap<>(4);
        }
    };


    public static Map<String, Object> getThreadLocal(){
        return threadLocal.get();
    }

    public static <T> T get(String key) {
        Map map = (Map)threadLocal.get();
        return (T)map.get(key);
    }

    public static <T> T get(String key,T defaultValue) {
        Map map = (Map)threadLocal.get();
        return (T)map.get(key) == null ? defaultValue : (T)map.get(key);
    }

    public static void set(String key, Object value) {
        Map map = (Map)threadLocal.get();
        map.put(key, value);
    }

    public static void set(Map<String, Object> keyValueMap) {
        Map map = (Map)threadLocal.get();
        map.putAll(keyValueMap);
    }

    public static void remove() {
        threadLocal.remove();
    }

    public static <T> Map<String,T> fetchVarsByPrefix(String prefix) {
        Map<String,T> vars = new HashMap<>();
        if( prefix == null ){
            return vars;
        }
        Map map = (Map)threadLocal.get();
        Set<Map.Entry> set = map.entrySet();

        for( Map.Entry entry : set){
            Object key = entry.getKey();
            if( key instanceof String ){
                if( ((String) key).startsWith(prefix) ){
                    vars.put((String)key,(T)entry.getValue());
                }
            }
        }
        return vars;
    }

    public static <T> T remove(String key) {
        Map map = (Map)threadLocal.get();
        return (T)map.remove(key);
    }

    public static void clear(String prefix) {
        if( prefix == null ){
            return;
        }
        Map map = (Map)threadLocal.get();
        Set<Map.Entry> set = map.entrySet();
        List<String> removeKeys = new ArrayList<>();

        for( Map.Entry entry : set ){
            Object key = entry.getKey();
            if( key instanceof String ){
                if( ((String) key).startsWith(prefix) ){
                    removeKeys.add((String)key);
                }
            }
        }
        for( String key : removeKeys ){
            map.remove(key);
        }
    }
}

總結(jié)

這個是目前第三方數(shù)據(jù)接口交互過程中常用的一些參數(shù)與使用示例乍楚,希望對大家有點(diǎn)幫助当编。當(dāng)然如果為了保證更加的安全,可以加上RSA,RSA2徒溪,AES等等加密方式忿偷,保證了數(shù)據(jù)的更加的安全,但是唯一的缺點(diǎn)是加密與解密比較耗費(fèi)CPU的資源.

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末臊泌,一起剝皮案震驚了整個濱河市鲤桥,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌缺虐,老刑警劉巖芜壁,帶你破解...
    沈念sama閱讀 221,576評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異高氮,居然都是意外死亡慧妄,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,515評論 3 399
  • 文/潘曉璐 我一進(jìn)店門剪芍,熙熙樓的掌柜王于貴愁眉苦臉地迎上來塞淹,“玉大人,你說我怎么就攤上這事罪裹”テ眨” “怎么了?”我有些...
    開封第一講書人閱讀 168,017評論 0 360
  • 文/不壞的土叔 我叫張陵状共,是天一觀的道長套耕。 經(jīng)常有香客問我,道長峡继,這世上最難降的妖魔是什么冯袍? 我笑而不...
    開封第一講書人閱讀 59,626評論 1 296
  • 正文 為了忘掉前任,我火速辦了婚禮碾牌,結(jié)果婚禮上康愤,老公的妹妹穿的比我還像新娘。我一直安慰自己舶吗,他們只是感情好征冷,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,625評論 6 397
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著誓琼,像睡著了一般检激。 火紅的嫁衣襯著肌膚如雪肴捉。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,255評論 1 308
  • 那天叔收,我揣著相機(jī)與錄音每庆,去河邊找鬼。 笑死今穿,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的伦籍。 我是一名探鬼主播蓝晒,決...
    沈念sama閱讀 40,825評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼帖鸦!你這毒婦竟也來了芝薇?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,729評論 0 276
  • 序言:老撾萬榮一對情侶失蹤作儿,失蹤者是張志新(化名)和其女友劉穎洛二,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體攻锰,經(jīng)...
    沈念sama閱讀 46,271評論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡晾嘶,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,363評論 3 340
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了娶吞。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片垒迂。...
    茶點(diǎn)故事閱讀 40,498評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖妒蛇,靈堂內(nèi)的尸體忽然破棺而出机断,到底是詐尸還是另有隱情,我是刑警寧澤绣夺,帶...
    沈念sama閱讀 36,183評論 5 350
  • 正文 年R本政府宣布吏奸,位于F島的核電站,受9級特大地震影響陶耍,放射性物質(zhì)發(fā)生泄漏奋蔚。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,867評論 3 333
  • 文/蒙蒙 一物臂、第九天 我趴在偏房一處隱蔽的房頂上張望旺拉。 院中可真熱鬧,春花似錦棵磷、人聲如沸蛾狗。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,338評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽沉桌。三九已至谢鹊,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間留凭,已是汗流浹背佃扼。 一陣腳步聲響...
    開封第一講書人閱讀 33,458評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留蔼夜,地道東北人兼耀。 一個月前我還...
    沈念sama閱讀 48,906評論 3 376
  • 正文 我出身青樓,卻偏偏與公主長得像求冷,于是被迫代替她去往敵國和親瘤运。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,507評論 2 359