文档工作

Author: techird

LICENSE

@@ -0,0 +1,24 @@
+LICENSE - "MIT License"
+
+Copyright (c) 2016 by Tencent Cloud
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,20 @@
+腾讯云微信小程序服务端 SDK - Java
+=================================
+
+本 SDK 是[腾讯云微信小程序一站式解决方案](https://github.com/tencentyun/weapp-solution)（下文简称「解决方案」）的组成部分。业务服务器可通过本 SDK 为小程序客户端提供云端服务支持，包括：
+
+1. 登录态鉴权服务
+2. 信道服务
+
+## SDK 获取
+
+本项目遵守 [MIT](LICENSE) 协议，可以直接[下载 SDK 源码](https://github.com/tencentyun/weapp-java-server-sdk/archive/master.zip)进行修改、编译和发布。
+
+> 如果从[腾讯云微信小程序控制台](https://console.qcloud.com/la)购买解决方案并选择 Java 语言，则分配的业务服务器里已经部署了本 SDK 和 Demo 的发行版本。
+
+## 使用示例（Servlet）
+
+> TODO
+
+## API
+

com.qcloud.weapp.demo/src/com/qcloud/weapp/demo/servlet/TunnelServlet.java

@@ -13,7 +13,6 @@
 import org.json.JSONObject;
 
 import com.qcloud.weapp.ConfigurationException;
-import com.qcloud.weapp.Logger;
 import com.qcloud.weapp.authorization.UserInfo;
 import com.qcloud.weapp.tunnel.EmitError;
 import com.qcloud.weapp.tunnel.EmitResult;
@@ -97,10 +96,8 @@ public void onTunnelMessage(Tunnel tunnel, TunnelMessage message) {
 
 				@Override
 				public void onTunnelClose(Tunnel tunnel) {
-					Logger.log("onTunnelClose()");
 					UserInfo leaveUser = null;
 					if (userMap.containsKey(tunnel.getTunnelId())) {
-						Logger.log("contains()");
 						leaveUser = userMap.get(tunnel.getTunnelId());
 						userMap.remove(tunnel.getTunnelId());
 					}
@@ -110,7 +107,6 @@ public void onTunnelClose(Tunnel tunnel) {
 						peopleMessage.put("total", room.getTunnelCount());
 						peopleMessage.put("leave", new JSONObject(leaveUser));
 					} catch (JSONException e) {
-						Logger.log("error: " + e.getMessage());
 						e.printStackTrace();
 					}
 					broadcast("people", peopleMessage);
@@ -131,7 +127,6 @@ private void broadcast(String messageType, JSONObject messageContent) {
 							onTunnelClose(Tunnel.getById(invalidInfo.getTunnelId()));
 						}
 					} catch (EmitError e) {
-						Logger.log("broadcast error: " + e.getMessage());
 						// 如果消息发送发生异常，这里可以进行错误处理或者重试的逻辑
 						e.printStackTrace();
 					}

com.qcloud.weapp.sdk/doc

@@ -1 +1 @@
-Subproject commit 26cccbbc406e80022b96677d9b55ddfe01c2463a
+Subproject commit addf77bb0e8b8ca68ecd35c7d51432b65d370985

com.qcloud.weapp.sdk/src/com/qcloud/weapp/Configuration.java

@@ -3,9 +3,10 @@
  */
 package com.qcloud.weapp;
 
-// TODO: Auto-generated Javadoc
 /**
- * The Class Configuration.
+ * 表示 SDK 配置
+ * @see com.qcloud.weapp.ConfigurationManager
+ * @see <a target="_blank" href="https://github.com/tencentyun/weapp-solution/wiki/%E6%9C%8D%E5%8A%A1%E7%AB%AF-SDK-%E9%85%8D%E7%BD%AE">服务端 SDK 配置</a>
  */
 public class Configuration {
 

com.qcloud.weapp.sdk/src/com/qcloud/weapp/ConfigurationException.java

@@ -1,9 +1,12 @@
 package com.qcloud.weapp;
 
+/**
+ * 表示配置时产生的异常
+ * */
 public class ConfigurationException extends Exception {
 	private static final long serialVersionUID = 570042088042301018L;
 
-	public ConfigurationException(String message) {
+	ConfigurationException(String message) {
 		super(message);
 	}
 }

com.qcloud.weapp.sdk/src/com/qcloud/weapp/ConfigurationManager.java

@@ -7,16 +7,29 @@
 import org.json.JSONException;
 import org.json.JSONObject;
 
+/**
+ * 配置管理，使用该类进行 SDK 配置
+ * */
 public class ConfigurationManager {
 
 	private static Configuration currentConfiguration;
+	
+	/**
+	 * 获取当前的 SDK 配置
+	 * */
 	public static Configuration getCurrentConfiguration() throws ConfigurationException {
 		if (currentConfiguration == null) {
 			throw new ConfigurationException("SDK 还没有进行配置，请调用 ConfigurationManager.setup() 方法配置 SDK");
 		}
 		return currentConfiguration;
 	}
 
+	/**
+	 * 使用指定的配置初始化 SDK
+	 * 
+	 * @param configuration 配置
+	 * @see <a target="_blank" href="https://github.com/tencentyun/weapp-solution/wiki/%E6%9C%8D%E5%8A%A1%E7%AB%AF-SDK-%E9%85%8D%E7%BD%AE">服务端 SDK 配置</a>
+	 * */
 	public static void setup(Configuration configuration) throws ConfigurationException {
 		if (configuration == null) {
 			throw new ConfigurationException("配置不能为空");
@@ -28,6 +41,12 @@ public static void setup(Configuration configuration) throws ConfigurationExcept
 		currentConfiguration = configuration;
 	}
 
+	/**
+	 * 从配置文件初始化 SDK
+	 * 
+	 * @param configFilePath 配置文件的路径
+	 * @see <a target="_blank" href="https://github.com/tencentyun/weapp-solution/wiki/%E6%9C%8D%E5%8A%A1%E7%AB%AF-SDK-%E9%85%8D%E7%BD%AE">服务端 SDK 配置</a>
+	 * */
 	public static void setupFromFile(String configFilePath) throws JSONException, ConfigurationException {
 		JSONObject configs = new JSONObject(getConfigJson(configFilePath));
 		Configuration configuration = new Configuration();

com.qcloud.weapp.sdk/src/com/qcloud/weapp/Hash.java

@@ -2,12 +2,21 @@
 
 import java.security.MessageDigest;
 
+/**
+ * 工具类，用于计算哈希值（SDK 内部使用）
+ * */
 public class Hash {
 
+	/**
+	 * 计算字符串的 sha1 哈希值
+	 * */
 	public static String sha1(String str) {
 		return compute(str, "SHA-1");
 	}
 
+	/**
+	 * 计算字符串的 md5 哈希值
+	 * */
 	public static String md5(String str) {
 		return compute(str, "MD5");
 	}

com.qcloud.weapp.sdk/src/com/qcloud/weapp/HttpRequest.java

@@ -11,6 +11,9 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+/**
+ * 用于创建网络请求，SDK 内部使用
+ * */
 public class HttpRequest {
 
 	public interface ConnectionProvider {

com.qcloud.weapp.sdk/src/com/qcloud/weapp/authorization/AuthorizationAPI.java

@@ -11,7 +11,7 @@
 import com.qcloud.weapp.ConfigurationManager;
 import com.qcloud.weapp.HttpRequest;
 
-public class AuthorizationAPI {
+class AuthorizationAPI {
 
 	private String getAPIUrl() throws ConfigurationException {
 		return ConfigurationManager.getCurrentConfiguration().getAuthServerUrl();