您的位置：首页 > 其它

Retrofit2.0 完美同步Cookie实现免登录

2017-02-13 15:49 330 查看

<div id="article_content" class="article_content">

<div class="markdown_views">原文出自csdn： 

<a href="http://blog.csdn.net/sk719887916/article/details/51700659">http://blog.csdn.net/sk719887916/article/details/51700659</a>

<h2 id="cookie"><a name="t0"></a>Cookie</h2>

Cookies是一种能够让网站服务器把少量数据储存到客户端的硬盘或内存，或是从客户端的硬盘读取数据的一种技术。Cookies是当你浏览某网站时，由Web服务器置于你硬盘上的一个非常小的文本文件，它可以记录你的用户ID、密码、浏览过的网页、停留的时间等信息。当你再次来到该网站时，网站通过读取Cookies，得知你的相关信息，就可以做出相应的动作，如在页面显示欢迎你的标语，或者让你不用输入ID、密码就直接登录等等。

从本质上讲，它可以看作是你的身份证。但Cookies不能作为代码执行，也不会传送病毒，且为你所专有，并只能由提供它的服务器来读取。保存的信息片断以“名/值”对(name-value pairs)的形式储存，一个“名/值”对仅仅是一条命名的数据。一个网站只能取得它放在你的电脑中的信息，它无法从其它的Cookies文件中取得信息，也无法得到你的电脑上的其它任何东西。

Cookies中的内容大多数经过了加密处理，因此一般用户看来只是一些毫无意义的字母数字组合，只有服务器的CGI处理程序才知道它们真正的含义。

Cookie也是http的会话跟踪技术，也包含web端的session。cookie的作用就是为了解决HTTP协议无状态的缺陷所作的努力.

<h2 id="自定义cookie"><a name="t1"></a>自定义cookie</h2>

HttpClient中大家都知道加入cookie的方式

<pre class="prettyprint" name="code"><code class="hljs axapta has-numbering">AsyncHttpClient client = new AsyncHttpClient();

PersistentCookieStore myCookieStore = new PersistentCookieStore(MainActivity.this);

client.setCookieStore(myCookieStore);</code><ul class="pre-numbering"><li>1</li><li>2</li><li>3</li></ul><div class="save_code tracking-ad" data-mod="popu_249" style="display: none;"><a href="javascript:;" target="_blank"><img
src="http://static.blog.csdn.net/images/save_snippets_01.png"></a></div><ul class="pre-numbering"><li>1</li><li>2</li><li>3</li></ul></pre>

因此Retrofit中需自我实现一个PersistentCookieStore 用来储存OkHttpCookies。

<h2 id="persistentcookiestore"><a name="t2"></a>PersistentCookieStore</h2>

<pre class="prettyprint" name="code"><code class="hljs java has-numbering">/**

* Created by LIUYONGKUI on 2016-06-09.

*/

public class PersistentCookieStore {

private static final String LOG_TAG = "PersistentCookieStore";

private static final String COOKIE_PREFS = "Cookies_Prefs";

private final Map<String, ConcurrentHashMap<String, Cookie>> cookies;

private final SharedPreferences cookiePrefs;

public PersistentCookieStore(Context context) {

cookiePrefs = context.getSharedPreferences(COOKIE_PREFS, 0);

cookies = new HashMap<>();

//将持久化的cookies缓存到内存中即map cookies

Map<String, ?> prefsMap = cookiePrefs.getAll();

for (Map.Entry<String, ?> entry : prefsMap.entrySet()) {

String[] cookieNames = TextUtils.split((String) entry.getValue(), ",");

for (String name : cookieNames) {

String encodedCookie = cookiePrefs.getString(name, null);

if (encodedCookie != null) {

Cookie decodedCookie = decodeCookie(encodedCookie);

if (decodedCookie != null) {

if (!cookies.containsKey(entry.getKey())) {

cookies.put(entry.getKey(), new ConcurrentHashMap<String, Cookie>());

}

cookies.get(entry.getKey()).put(name, decodedCookie);

}

}

}

}

}

protected String getCookieToken(Cookie cookie) {

return cookie.name() + "@" + cookie.domain();

}

public void add(HttpUrl url, Cookie cookie) {

String name = getCookieToken(cookie);

//将cookies缓存到内存中如果缓存过期就重置此cookie

if (!cookie.persistent()) {

if (!cookies.containsKey(url.host())) {

cookies.put(url.host(), new ConcurrentHashMap<String, Cookie>());

}

cookies.get(url.host()).put(name, cookie);

} else {

if (cookies.containsKey(url.host())) {

cookies.get(url.host()).remove(name);

}

}

//将cookies持久化到本地

SharedPreferences.Editor prefsWriter = cookiePrefs.edit();

prefsWriter.putString(url.host(), TextUtils.join(",", cookies.get(url.host()).keySet()));

prefsWriter.putString(name, encodeCookie(new OkHttpCookies(cookie)));

prefsWriter.apply();

}

public List<Cookie> get(HttpUrl url) {

ArrayList<Cookie> ret = new ArrayList<>();

if (cookies.containsKey(url.host()))

ret.addAll(cookies.get(url.host()).values());

return ret;

}

public boolean removeAll() {

SharedPreferences.Editor prefsWriter = cookiePrefs.edit();

prefsWriter.clear();

prefsWriter.apply();

cookies.clear();

return true;

}

public boolean remove(HttpUrl url, Cookie cookie) {

String name = getCookieToken(cookie);

if (cookies.containsKey(url.host()) && cookies.get(url.host()).containsKey(name)) {

cookies.get(url.host()).remove(name);

SharedPreferences.Editor prefsWriter = cookiePrefs.edit();

if (cookiePrefs.contains(name)) {

prefsWriter.remove(name);

}
119e6

prefsWriter.putString(url.host(), TextUtils.join(",", cookies.get(url.host()).keySet()));

prefsWriter.apply();

return true;

} else {

return false;

}

}

public List<Cookie> getCookies() {

ArrayList<Cookie> ret = new ArrayList<>();

for (String key : cookies.keySet())

ret.addAll(cookies.get(key).values());

return ret;

}

/**

* cookies 序列化成 string

*

* @param cookie 要序列化的cookie

* @return 序列化之后的string

*/

protected String encodeCookie(OkHttpCookies cookie) {

if (cookie == null)

return null;

ByteArrayOutputStream os = new ByteArrayOutputStream();

try {

ObjectOutputStream outputStream = new ObjectOutputStream(os);

outputStream.writeObject(cookie);

} catch (IOException e) {

Log.d(LOG_TAG, "IOException in encodeCookie", e);

return null;

}

return byteArrayToHexString(os.toByteArray());

}

/**

* 将字符串反序列化成cookies

*

* @param cookieString cookies string

* @return cookie object

*/

protected Cookie decodeCookie(String cookieString) {

byte[] bytes = hexStringToByteArray(cookieString);

ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(bytes);

Cookie cookie = null;

try {

ObjectInputStream objectInputStream = new ObjectInputStream(byteArrayInputStream);

cookie = ((OkHttpCookies) objectInputStream.readObject()).getCookies();

} catch (IOException e) {

Log.d(LOG_TAG, "IOException in decodeCookie", e);

} catch (ClassNotFoundException e) {

Log.d(LOG_TAG, "ClassNotFoundException in decodeCookie", e);

}

return cookie;

}

/**

* 二进制数组转十六进制字符串

*

* @param bytes byte array to be converted

* @return string containing hex values

*/

protected String byteArrayToHexString(byte[] bytes) {

StringBuilder sb = new StringBuilder(bytes.length * 2);

for (byte element : bytes) {

int v = element & 0xff;

if (v < 16) {

sb.append('0');

}

sb.append(Integer.toHexString(v));

}

return sb.toString().toUpperCase(Locale.US);

}

/**

* 十六进制字符串转二进制数组

*

* @param hexString string of hex-encoded values

* @return decoded byte array

*/

protected byte[] hexStringToByteArray(String hexString) {

int len = hexString.length();

byte[] data = new byte[len / 2];

for (int i = 0; i < len; i += 2) {

data[i / 2] = (byte) ((Character.digit(hexString.charAt(i), 16) << 4) + Character.digit(hexString.charAt(i + 1), 16));

}

return data;

}</code><ul class="pre-numbering"><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li><li>7</li><li>8</li><li>9</li><li>10</li><li>11</li><li>12</li><li>13</li><li>14</li><li>15</li><li>16</li><li>17</li><li>18</li><li>19</li><li>20</li><li>21</li><li>22</li><li>23</li><li>24</li><li>25</li><li>26</li><li>27</li><li>28</li><li>29</li><li>30</li><li>31</li><li>32</li><li>33</li><li>34</li><li>35</li><li>36</li><li>37</li><li>38</li><li>39</li><li>40</li><li>41</li><li>42</li><li>43</li><li>44</li><li>45</li><li>46</li><li>47</li><li>48</li><li>49</li><li>50</li><li>51</li><li>52</li><li>53</li><li>54</li><li>55</li><li>56</li><li>57</li><li>58</li><li>59</li><li>60</li><li>61</li><li>62</li><li>63</li><li>64</li><li>65</li><li>66</li><li>67</li><li>68</li><li>69</li><li>70</li><li>71</li><li>72</li><li>73</li><li>74</li><li>75</li><li>76</li><li>77</li><li>78</li><li>79</li><li>80</li><li>81</li><li>82</li><li>83</li><li>84</li><li>85</li><li>86</li><li>87</li><li>88</li><li>89</li><li>90</li><li>91</li><li>92</li><li>93</li><li>94</li><li>95</li><li>96</li><li>97</li><li>98</li><li>99</li><li>100</li><li>101</li><li>102</li><li>103</li><li>104</li><li>105</li><li>106</li><li>107</li><li>108</li><li>109</li><li>110</li><li>111</li><li>112</li><li>113</li><li>114</li><li>115</li><li>116</li><li>117</li><li>118</li><li>119</li><li>120</li><li>121</li><li>122</li><li>123</li><li>124</li><li>125</li><li>126</li><li>127</li><li>128</li><li>129</li><li>130</li><li>131</li><li>132</li><li>133</li><li>134</li><li>135</li><li>136</li><li>137</li><li>138</li><li>139</li><li>140</li><li>141</li><li>142</li><li>143</li><li>144</li><li>145</li><li>146</li><li>147</li><li>148</li><li>149</li><li>150</li><li>151</li><li>152</li><li>153</li><li>154</li><li>155</li><li>156</li><li>157</li><li>158</li><li>159</li><li>160</li><li>161</li><li>162</li><li>163</li><li>164</li><li>165</li><li>166</li><li>167</li><li>168</li><li>169</li><li>170</li><li>171</li><li>172</li><li>173</li><li>174</li><li>175</li><li>176</li></ul><div
class="save_code tracking-ad" data-mod="popu_249" style="display: none;"><a href="javascript:;" target="_blank"><img src="http://static.blog.csdn.net/images/save_snippets.png"></a></div><ul class="pre-numbering"><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li><li>7</li><li>8</li><li>9</li><li>10</li><li>11</li><li>12</li><li>13</li><li>14</li><li>15</li><li>16</li><li>17</li><li>18</li><li>19</li><li>20</li><li>21</li><li>22</li><li>23</li><li>24</li><li>25</li><li>26</li><li>27</li><li>28</li><li>29</li><li>30</li><li>31</li><li>32</li><li>33</li><li>34</li><li>35</li><li>36</li><li>37</li><li>38</li><li>39</li><li>40</li><li>41</li><li>42</li><li>43</li><li>44</li><li>45</li><li>46</li><li>47</li><li>48</li><li>49</li><li>50</li><li>51</li><li>52</li><li>53</li><li>54</li><li>55</li><li>56</li><li>57</li><li>58</li><li>59</li><li>60</li><li>61</li><li>62</li><li>63</li><li>64</li><li>65</li><li>66</li><li>67</li><li>68</li><li>69</li><li>70</li><li>71</li><li>72</li><li>73</li><li>74</li><li>75</li><li>76</li><li>77</li><li>78</li><li>79</li><li>80</li><li>81</li><li>82</li><li>83</li><li>84</li><li>85</li><li>86</li><li>87</li><li>88</li><li>89</li><li>90</li><li>91</li><li>92</li><li>93</li><li>94</li><li>95</li><li>96</li><li>97</li><li>98</li><li>99</li><li>100</li><li>101</li><li>102</li><li>103</li><li>104</li><li>105</li><li>106</li><li>107</li><li>108</li><li>109</li><li>110</li><li>111</li><li>112</li><li>113</li><li>114</li><li>115</li><li>116</li><li>117</li><li>118</li><li>119</li><li>120</li><li>121</li><li>122</li><li>123</li><li>124</li><li>125</li><li>126</li><li>127</li><li>128</li><li>129</li><li>130</li><li>131</li><li>132</li><li>133</li><li>134</li><li>135</li><li>136</li><li>137</li><li>138</li><li>139</li><li>140</li><li>141</li><li>142</li><li>143</li><li>144</li><li>145</li><li>146</li><li>147</li><li>148</li><li>149</li><li>150</li><li>151</li><li>152</li><li>153</li><li>154</li><li>155</li><li>156</li><li>157</li><li>158</li><li>159</li><li>160</li><li>161</li><li>162</li><li>163</li><li>164</li><li>165</li><li>166</li><li>167</li><li>168</li><li>169</li><li>170</li><li>171</li><li>172</li><li>173</li><li>174</li><li>175</li><li>176</li></ul></pre>

<h2 id="okhttpcookies"><a name="t3"></a>OkHttpCookies</h2>

需要实现序列化的 OkHttpCookies 用来持久OkHttpCookies

<pre class="prettyprint" name="code"><code class="hljs avrasm has-numbering"> /**

* Created by LIUYONGKUI on 2016-05-20.

*/

public class OkHttpCookies implements Serializable {

private transient final Cookie cookies;

private transient Cookie clientCookies;

public OkHttpCookies(Cookie cookies) {

this.cookies = cookies;

}

public Cookie getCookies() {

Cookie bestCookies = cookies;

if (clientCookies != null) {

bestCookies = clientCookies;

}

return bestCookies;

}

private void writeObject(ObjectOutputStream out) throws IOException {

out.writeObject(cookies.name());

out.writeObject(cookies.value());

out.writeLong(cookies.expiresAt());

out.writeObject(cookies.domain());

out.writeObject(cookies.path());

out.writeBoolean(cookies.secure());

out.writeBoolean(cookies.httpOnly());

out.writeBoolean(cookies.hostOnly());

out.writeBoolean(cookies.persistent());

}

private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {

String name = (String) in.readObject();

String value = (String) in.readObject();

long expiresAt = in.readLong();

String domain = (String) in.readObject();

String path = (String) in.readObject();

boolean secure = in.readBoolean();

boolean httpOnly = in.readBoolean();

boolean hostOnly = in.readBoolean();

boolean persistent = in.readBoolean();

Cookie.Builder builder = new Cookie.Builder();

builder = builder.name(name);

builder = builder.value(value);

builder = builder.expiresAt(expiresAt);

builder = hostOnly ? builder.hostOnlyDomain(domain) : builder.domain(domain);

builder = builder.path(path);

builder = secure ? builder.secure() : builder;

builder = httpOnly ? builder.httpOnly() : builder;

clientCookies =builder.build();

}

}</code><ul class="pre-numbering"><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li><li>7</li><li>8</li><li>9</li><li>10</li><li>11</li><li>12</li><li>13</li><li>14</li><li>15</li><li>16</li><li>17</li><li>18</li><li>19</li><li>20</li><li>21</li><li>22</li><li>23</li><li>24</li><li>25</li><li>26</li><li>27</li><li>28</li><li>29</li><li>30</li><li>31</li><li>32</li><li>33</li><li>34</li><li>35</li><li>36</li><li>37</li><li>38</li><li>39</li><li>40</li><li>41</li><li>42</li><li>43</li><li>44</li><li>45</li><li>46</li><li>47</li><li>48</li><li>49</li><li>50</li><li>51</li><li>52</li></ul><div
class="save_code tracking-ad" data-mod="popu_249" style="display: none;"><a href="javascript:;" target="_blank"><img src="http://static.blog.csdn.net/images/save_snippets.png"></a></div><ul class="pre-numbering"><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li><li>7</li><li>8</li><li>9</li><li>10</li><li>11</li><li>12</li><li>13</li><li>14</li><li>15</li><li>16</li><li>17</li><li>18</li><li>19</li><li>20</li><li>21</li><li>22</li><li>23</li><li>24</li><li>25</li><li>26</li><li>27</li><li>28</li><li>29</li><li>30</li><li>31</li><li>32</li><li>33</li><li>34</li><li>35</li><li>36</li><li>37</li><li>38</li><li>39</li><li>40</li><li>41</li><li>42</li><li>43</li><li>44</li><li>45</li><li>46</li><li>47</li><li>48</li><li>49</li><li>50</li><li>51</li><li>52</li></ul></pre>

<h2 id="自定义cookiemanger"><a name="t4"></a>自定义CookieManger</h2>

实现有一个自定义的CookieManger来管理cookies,实现以K-V结构获取set、getCookier

<pre class="prettyprint" name="code"><code class="hljs java has-numbering">public class CookieManger implements
CookieJar {

public static String APP_PLATFORM = "app-platform";

private static Context mContext;

private static PersistentCookieStore cookieStore;

public CookieManger(Context context) {

mContext = context;

if (cookieStore == null ) {

cookieStore = new PersistentCookieStore(mContext);

}

}

@Override

public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {

if (cookies != null && cookies.size() > 0) {

for (Cookie item : cookies) {

cookieStore.add(url, item);

}

}

}

@Override

public List<Cookie> loadForRequest(HttpUrl url) {

List<Cookie> cookies =cookieStore.get(url);

return cookies;

}

static class Customer {

private String userID;

private String token;

public Customer(String userID, String token) {

this.userID = userID;

this.token = token;

}

public String getUserID() {

return userID;

}

public void setUserID(String userID) {

this.userID = userID;

}

public String getToken() {

return token;

}

public void setToken(String token) {

this.token = token;

}

}</code><ul class="pre-numbering"><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li><li>7</li><li>8</li><li>9</li><li>10</li><li>11</li><li>12</li><li>13</li><li>14</li><li>15</li><li>16</li><li>17</li><li>18</li><li>19</li><li>20</li><li>21</li><li>22</li><li>23</li><li>24</li><li>25</li><li>26</li><li>27</li><li>28</li><li>29</li><li>30</li><li>31</li><li>32</li><li>33</li><li>34</li><li>35</li><li>36</li><li>37</li><li>38</li><li>39</li><li>40</li><li>41</li><li>42</li><li>43</li><li>44</li><li>45</li><li>46</li><li>47</li><li>48</li><li>49</li><li>50</li><li>51</li><li>52</li><li>53</li><li>54</li><li>55</li><li>56</li><li>57</li><li>58</li><li>59</li><li>60</li></ul><div
class="save_code tracking-ad" data-mod="popu_249" style="display: none;"><a href="javascript:;" target="_blank"><img src="http://static.blog.csdn.net/images/save_snippets.png"></a></div><ul class="pre-numbering"><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li><li>7</li><li>8</li><li>9</li><li>10</li><li>11</li><li>12</li><li>13</li><li>14</li><li>15</li><li>16</li><li>17</li><li>18</li><li>19</li><li>20</li><li>21</li><li>22</li><li>23</li><li>24</li><li>25</li><li>26</li><li>27</li><li>28</li><li>29</li><li>30</li><li>31</li><li>32</li><li>33</li><li>34</li><li>35</li><li>36</li><li>37</li><li>38</li><li>39</li><li>40</li><li>41</li><li>42</li><li>43</li><li>44</li><li>45</li><li>46</li><li>47</li><li>48</li><li>49</li><li>50</li><li>51</li><li>52</li><li>53</li><li>54</li><li>55</li><li>56</li><li>57</li><li>58</li><li>59</li><li>60</li></ul></pre>

<h2 id="retrofit加入cookie"><a name="t5"></a>Retrofit加入cookie</h2>

<pre class="prettyprint" name="code"><code class="hljs avrasm has-numbering">OkHttpClient okHttpClient = new OkHttpClient.Builder()

.addNetworkInterceptor(

new HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.HEADERS))

.cookieJar(new CookieManger(context))

.addInterceptor(loginInterceptor)

.connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)

.build();

Retrofit retrofit = new Retrofit.Builder()

.client(okHttpClient)

.build();</code><ul class="pre-numbering"><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li><li>7</li><li>8</li><li>9</li><li>10</li><li>11</li></ul><div class="save_code
tracking-ad" data-mod="popu_249" style="display: none;"><a href="javascript:;" target="_blank"><img src="http://static.blog.csdn.net/images/save_snippets.png"></a></div><ul class="pre-numbering"><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li><li>7</li><li>8</li><li>9</li><li>10</li><li>11</li></ul></pre>

<h2 id="总结"><a name="t6"></a>总结</h2>

实现加入cookies持久，实现免登陆基本步骤

<pre class="prettyprint" name="code"><code class="hljs erlang-repl has-numbering">1 实现可序列化的OkHttpcookies

2 实现储存OkHttpcookies的PersistentCookieStore

3 实现cookies管理工具CookieManger

4 构建OKHttpClient

5 Retrofit加入自定义的okHttpClient

6 直接调用RetrofitClient</code><ul class="pre-numbering"><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li></ul><div class="save_code tracking-ad" data-mod="popu_249" style="display:
none;"><a href="javascript:;" target="_blank"><img src="http://static.blog.csdn.net/images/save_snippets.png"></a></div><ul class="pre-numbering"><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li></ul></pre></div>

<script type="text/javascript">

$(function () {

$('pre.prettyprint code').each(function () {

var lines = $(this).text().split('\n').length;

var $numbering = $('<ul></ul>').addClass('pre-numbering').hide();

$(this).addClass('has-numbering').parent().append($numbering);

for (i = 1; i <= lines; i++) {

$numbering.append($('<li></li>').text(i));

};

$numbering.fadeIn(1700);

});

});

</script>

</div>

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理

标签：

相关文章推荐

新的分享

章节导航