modify HttpCache.java

Trinea · Trinea · commit 96f210d8f148 · 2013-11-15T20:42:53.000+08:00
diff --git a/src/cn/trinea/android/common/dao/HttpCacheDao.java b/src/cn/trinea/android/common/dao/HttpCacheDao.java
@@ -15,7 +15,7 @@ public interface HttpCacheDao {
      * insert HttpResponse
      * 
      * @param httpResponse
-     * @return
+     * @return the row ID of the newly inserted row, or -1 if an error occurred
      */
     public long insertHttpResponse(HttpResponse httpResponse);
 
diff --git a/src/cn/trinea/android/common/dao/impl/HttpCacheDaoImpl.java b/src/cn/trinea/android/common/dao/impl/HttpCacheDaoImpl.java
@@ -130,7 +130,7 @@ private HttpResponse cursorToHttpResponse(Cursor cursor, String url) {
      * @return
      */
     private static ContentValues httpResponseToCV(HttpResponse httpResponse) {
-        if (httpResponse == null) {
+        if (httpResponse == null || StringUtils.isEmpty(httpResponse.getUrl())) {
             return null;
         }
 
diff --git a/src/cn/trinea/android/common/service/HttpCache.java b/src/cn/trinea/android/common/service/HttpCache.java
@@ -30,6 +30,8 @@ public class HttpCache extends SimpleCache<String, HttpResponse> {
     /** dao to get data from http db cache **/
     private HttpCacheDao              httpCacheDaoImpl;
 
+    private int                       type = -1;
+
     public HttpCache(Context context){
         if (context == null) {
             throw new IllegalArgumentException("The context can not be null.");
@@ -45,6 +47,7 @@ public HttpCache(Context context){
      */
     public HttpCache(Context context, int type){
         this(context);
+        this.type = type;
         initData(type);
     }
 
@@ -60,32 +63,105 @@ private void initData(int type) {
         }
     }
 
+    /**
+     * http get
+     * <ul>
+     * <strong>Attentions:</strong>
+     * <li>Don't call this on the ui thread, it may costs some times. Becaust if not in cache, it get from network
+     * synchronous.</li>
+     * <li>If you want get data asynchronous, use {@link HttpCache#httpGet(HttpRequest, HttpCacheListener)}</li>
+     * </ul>
+     * 
+     * @param httpRequest
+     * @return the response of the url, if null represents http error
+     */
     public HttpResponse httpGet(HttpRequest request) {
         String url;
         if (request == null || StringUtils.isEmpty(url = request.getUrl())) {
             return null;
         }
 
         HttpResponse cacheResponse = getFromCache(url);
-        return cacheResponse == null ? HttpUtils.httpGet(request) : cacheResponse;
+        return cacheResponse == null ? putIntoCache(HttpUtils.httpGet(url)) : cacheResponse;
     }
 
+    /**
+     * http get
+     * <ul>
+     * <li>It gets data from cache or network asynchronous.</li>
+     * <li>If you want get data synchronous, use {@link HttpCache#httpGet(HttpRequest)} or
+     * {@link HttpCache#httpGetString(HttpRequest)}</li>
+     * </ul>
+     * 
+     * @param httpUrl
+     * @param listener
+     */
     public void httpGet(String httpUrl, HttpCacheListener listener) {
         new HttpCacheStringAsyncTask(listener).execute(httpUrl);
     }
 
+    /**
+     * http get
+     * <ul>
+     * <li>It gets data from cache or network asynchronous.</li>
+     * <li>If you want get data synchronous, use {@link HttpCache#httpGet(HttpRequest)} or
+     * {@link HttpCache#httpGetString(HttpRequest)}</li>
+     * </ul>
+     * 
+     * @param request
+     * @param listener
+     */
     public void httpGet(HttpRequest request, HttpCacheListener listener) {
         new HttpCacheRequestAsyncTask(listener).execute(request);
     }
 
+    /**
+     * http get
+     * <ul>
+     * <strong>Attentions:</strong>
+     * <li>Don't call this on the ui thread, it may costs some times. Becaust if not in cache, it get from network
+     * synchronous.</li>
+     * <li>If you want get data asynchronous, use {@link HttpCache#httpGet(HttpRequest, HttpCacheListener)}</li>
+     * </ul>
+     * 
+     * @param httpUrl
+     * @return the response of the url, if null represents http error
+     */
     public HttpResponse httpGet(String httpUrl) {
-        HttpResponse cacheResponse = getFromCache(httpUrl);
-        return cacheResponse == null ? HttpUtils.httpGet(httpUrl) : cacheResponse;
+        return httpGet(new HttpRequest(httpUrl));
     }
 
+    /**
+     * http get
+     * <ul>
+     * <strong>Attentions:</strong>
+     * <li>Don't call this on the ui thread, it may costs some times. Becaust if not in cache, it get from network
+     * synchronous.</li>
+     * <li>If you want get data asynchronous, use {@link HttpCache#httpGet(String, HttpCacheListener)}</li>
+     * </ul>
+     * 
+     * @param httpUrl
+     * @return the response body of the url, if null represents http error
+     */
     public String httpGetString(String httpUrl) {
-        HttpResponse cacheResponse = getFromCache(httpUrl);
-        return cacheResponse == null ? HttpUtils.httpGetString(httpUrl) : cacheResponse.getResponseBody();
+        HttpResponse cacheResponse = httpGet(new HttpRequest(httpUrl));
+        return cacheResponse == null ? null : cacheResponse.getResponseBody();
+    }
+
+    /**
+     * http get
+     * <ul>
+     * <strong>Attentions:</strong>
+     * <li>Don't call this on the ui thread, it may costs some times. Becaust if not in cache, it get from network
+     * synchronous.</li>
+     * <li>If you want get data asynchronous, use {@link HttpCache#httpGet(HttpRequest, HttpCacheListener)}</li>
+     * </ul>
+     * 
+     * @param httpRequest
+     * @return the response body of the url, if null represents http error
+     */
+    public HttpResponse httpGetString(HttpRequest httpRequest) {
+        return httpGet(httpRequest);
     }
 
     public abstract class HttpCacheListener {
@@ -98,6 +174,46 @@ protected void onPostExecute(HttpResponse httpResponse) {
 
     }
 
+    /**
+     * get type
+     * 
+     * @return the type
+     */
+    public int getType() {
+        return type;
+    }
+
+    /**
+     * set type
+     * 
+     * @param type the type to set
+     */
+    public void setType(int type) {
+        this.type = type;
+    }
+
+    /**
+     * put response into cache
+     * <ul>
+     * <li>put response to db, if {@link HttpResponse#getType()} == {@link HttpCache#getType()}, also put into memory
+     * cache</li>
+     * </ul>
+     * 
+     * @param httpResponse
+     * @return if insert into db error, return null, otherwise return HttpResponse
+     */
+    private HttpResponse putIntoCache(HttpResponse httpResponse) {
+        String url;
+        if (httpResponse == null || (url = httpResponse.getUrl()) == null) {
+            return null;
+        }
+
+        if (type != -1 && type == httpResponse.getType()) {
+            cache.put(url, httpResponse);
+        }
+        return (httpCacheDaoImpl.insertHttpResponse(httpResponse) == -1) ? null : httpResponse;
+    }
+
     /**
      * get from memory cache first, if not exist in memory cache, get from db
      * 

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public interface HttpCacheDao {`
`15`	`15`	`* insert HttpResponse`
`16`	`16`	`*`
`17`	`17`	`* @param httpResponse`
`18`		`- * @return`
	`18`	`+ * @return the row ID of the newly inserted row, or -1 if an error occurred`
`19`	`19`	`*/`
`20`	`20`	`public long insertHttpResponse(HttpResponse httpResponse);`
`21`	`21`
Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,7 @@ private HttpResponse cursorToHttpResponse(Cursor cursor, String url) {`
`130`	`130`	`* @return`
`131`	`131`	`*/`
`132`	`132`	`private static ContentValues httpResponseToCV(HttpResponse httpResponse) {`
`133`		`- if (httpResponse == null) {`
	`133`	`+ if (httpResponse == null \|\| StringUtils.isEmpty(httpResponse.getUrl())) {`
`134`	`134`	`return null;`
`135`	`135`	`}`
`136`	`136`