Java：APIJSONBootTest 重命名为 APIJSONDemo； APIJSONFinal 中 AppRunnableConfig 重命名为 DemoAppConfig；升级 APIJSONORM 和 apijson-framework 的版本；完善使用文档；

Author: TommyLemon

.gitignore

@@ -6,3 +6,4 @@ APIJSON-Java-Server/APIJSONBootTest/.settings
 APIJSON-Java-Server/APIJSONFinal/.settings
 APIJSON-Java-Server/APIJSONFinal/.idea
 apijson-final.iml
+APIJSON-Java-Server/APIJSONDemo/.settings

APIJSON-Java-Server/APIJSONBoot/README.md

@@ -0,0 +1,7 @@
+# APIJSONBoot
+
+APIJSON + SpringBoot 接近成品的 Demo
+
+### 运行
+
+右键 DemoApplication > Run As > Java Application

APIJSON-Java-Server/APIJSONBoot/libs/apijson-framework-4.4.0.jar

@@ -38,15 +38,15 @@
 		</dependency>
 
 		<!-- 可使用 libs 目录的 apijson-orm.jar 和 apijson-framework.jar 来替代，两种方式二选一 <<<<<<<<<< -->
-		<dependency>
+	 	<dependency>
 			<groupId>com.github.Tencent</groupId>
 			<artifactId>APIJSON</artifactId>
-			<version>4.2.4</version>
+			<version>4.2.5</version>
 		</dependency>
 		<dependency>
 			<groupId>com.github.APIJSON</groupId>
 			<artifactId>apijson-framework</artifactId>
-			<version>4.4.0</version>
+			<version>4.4.3</version>
 		</dependency>
 		<!-- 可使用 libs 目录的 apijson-orm.jar 和 apijson-framework.jar 来替代，两种方式二选一 >>>>>>>>>> -->
 

APIJSON-Java-Server/APIJSONBoot/libs/apijson-framework-4.4.2.jar

@@ -41,8 +41,13 @@ public DemoSQLConfig(RequestMethod method, String table) {
 		DEFAULT_DATABASE = DATABASE_MYSQL;  //TODO 默认数据库类型，改成你自己的
 		DEFAULT_SCHEMA = "sys";  //TODO 默认模式名，改成你自己的，默认情况是 MySQL: sys, PostgreSQL: public, SQL Server: dbo, Oracle: 
 
-		//  由 DemoVerifier.init 方法读取数据库 Access 表来替代手动输入配置
-		//		//表名映射，隐藏真实表名，对安全要求很高的表可以这么做
+		//表名和数据库不一致的，需要配置映射关系。只使用 APIJSONORM 时才需要；
+		//这个 Demo 用了 apijson-framework 且调用了 APIJSONApplication.init
+		//(间接调用 DemoVerifier.init 方法读取数据库 Access 表来替代手动输入配置)，所以不需要。
+		//但如果 Access 这张表的对外表名与数据库实际表名不一致，仍然需要这里注册。例如
+		//		TABLE_KEY_MAP.put(Access.class.getSimpleName(), "access");
+
+		//表名映射，隐藏真实表名，对安全要求很高的表可以这么做
 		//		TABLE_KEY_MAP.put(User.class.getSimpleName(), "apijson_user");
 		//		TABLE_KEY_MAP.put(Privacy.class.getSimpleName(), "apijson_privacy");
 
@@ -72,11 +77,11 @@ public String getUserIdKey(String database, String schema, String table) {
 			//			public Object newId(RequestMethod method, String database, String schema, String table) {
 			//				return null; // return null 则不生成 id，一般用于数据库自增 id
 			//			}
-			
-//			@Override
-//			public void onMissingKey4Combine(String name, JSONObject request, String combine, String item, String key) throws Exception {
-////				super.onMissingKey4Combine(name, request, combine, item, key);
-//			}
+
+			//			@Override
+			//			public void onMissingKey4Combine(String name, JSONObject request, String combine, String item, String key) throws Exception {
+			////				super.onMissingKey4Combine(name, request, combine, item, key);
+			//			}
 		};
 
 		// 自定义where条件拼接
@@ -161,7 +166,13 @@ public String getDBPassword() {
 		}
 		return null;
 	}
-	
+
+	//取消注释后，默认的 APIJSON 配置表会由业务表所在数据库模式 schema 改为自定义的
+	//	@Override
+	//	public String getConfigSchema() {
+	//		return "apijson";
+	//	}
+
 	//取消注释后，默认的数据库类型会由 MySQL 改为 PostgreSQL
 	//	@Override
 	//	public String getDatabase() {

APIJSON-Java-Server/APIJSONBoot/libs/apijson-orm-4.2.3.jar

@@ -0,0 +1,7 @@
+# APIJSONDemo
+
+APIJSON + SpringBoot 初级使用的最简单 Demo
+
+### 运行
+
+右键 DemoApplication > Run As > Java Application

APIJSON-Java-Server/APIJSONBoot/libs/apijson-orm-4.2.5.jar

@@ -3,12 +3,12 @@
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 
-	<groupId>apijson.boot.test</groupId>
-	<artifactId>apijson-boot-test</artifactId>
+	<groupId>apijson.demo</groupId>
+	<artifactId>apijson-demo</artifactId>
 	<version>4.0.0</version>
 	<packaging>jar</packaging>
 
-	<name>APIJSONBootTest</name>
+	<name>APIJSONDemo</name>
 	<description>Demo project for Testing APIJSON Server based on SpringBoot</description>
 
 	<parent>
@@ -29,7 +29,7 @@
 		<dependency>
 			<groupId>com.alibaba</groupId>
 			<artifactId>fastjson</artifactId>
-			<version>1.2.73</version>
+			<version>1.2.74</version>
 		</dependency>
 
 		<!-- APIJSONBoot 需要用的 Spring 框架，1.4.1 以上 -->

APIJSON-Java-Server/APIJSONBoot/pom.xml

@@ -12,7 +12,7 @@
 See the License for the specific language governing permissions and
 limitations under the License.*/
 
-package apijson.boot.test;
+package apijson.demo;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
@@ -42,7 +42,7 @@ public SQLConfig createSQLConfig() {
 
 	public static void main(String[] args) throws Exception {
 		SpringApplication.run(DemoApplication.class, args);
-        System.out.println("\n\n<<<<<<<<<<<<<<<<<<<<<<<<< APIJSON 启动完成，试试调用自动化 API 吧 ^_^ >>>>>>>>>>>>>>>>>>>>>>>>\n");
+		APIJSONApplication.init(false);  // 4.4.0 以上需要这句来保证以上 static 代码块中给 DEFAULT_APIJSON_CREATOR 赋值会生效
 	}
 
 }

APIJSON-Java-Server/APIJSONBoot/src/main/java/apijson/demo/DemoSQLConfig.java

@@ -12,7 +12,7 @@
 See the License for the specific language governing permissions and
 limitations under the License.*/
 
-package apijson.boot.test;
+package apijson.demo;
 
 import java.net.URLDecoder;
 
@@ -30,6 +30,9 @@
 import apijson.orm.Parser;
 
 
+/**提供入口，转交给 APIJSON 的 Parser 来处理
+ * @author Lemon
+ */
 @RestController
 @RequestMapping("")
 public class DemoController extends APIJSONController {

APIJSON-Java-Server/APIJSONBootTest/src/main/java/apijson/boot/test/DemoSQLConfig.java

@@ -0,0 +1,58 @@
+/*Copyright ©2016 TommyLemon(https://github.com/TommyLemon/APIJSON)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.*/
+
+package apijson.demo;
+
+import apijson.framework.APIJSONSQLConfig;
+
+
+/**SQL配置
+ * TiDB 用法和 MySQL 一致
+ * @author Lemon
+ */
+public class DemoSQLConfig extends APIJSONSQLConfig {
+
+	static {
+		DEFAULT_DATABASE = DATABASE_MYSQL;  // TODO 默认数据库类型，改成你自己的
+		DEFAULT_SCHEMA = "sys";  // TODO 默认模式名，改成你自己的，默认情况是 MySQL: sys, PostgreSQL: public, SQL Server: dbo, Oracle: 
+
+		// 表名和数据库不一致的，需要配置映射关系。只使用 APIJSONORM 时才需要；
+		// 如果用了 apijson-framework 且调用了 APIJSONApplication.init
+		// (间接调用 DemoVerifier.init 方法读取数据库 Access 表来替代手动输入配置)，则不需要。
+		// 但如果 Access 这张表的对外表名与数据库实际表名不一致，仍然需要这里注册。例如
+		//		TABLE_KEY_MAP.put(Access.class.getSimpleName(), "access");
+
+		//表名映射，隐藏真实表名，对安全要求很高的表可以这么做
+		TABLE_KEY_MAP.put("User", "apijson_user");
+		TABLE_KEY_MAP.put("Privacy", "apijson_privacy");
+	}
+
+	@Override
+	public String getDBVersion() {
+		return "5.7.22";  // "8.0.11";  // TODO 改成你自己的 MySQL 或 PostgreSQL 数据库版本号  // MYSQL 8 和 7 使用的 JDBC 配置不一样
+	}
+	@Override
+	public String getDBUri() {
+		return "jdbc:mysql://localhost:3306"; // TODO 改成你自己的，TiDB 可以当成 MySQL 使用，默认端口为 4000
+	}
+	@Override
+	public String getDBAccount() {
+		return "root";  // TODO 改成你自己的
+	}
+	@Override
+	public String getDBPassword() {
+		return "apijson";  // TODO 改成你自己的，TiDB 可以当成 MySQL 使用， 默认密码为空字符串 ""
+	}
+
+}

APIJSON-Java-Server/APIJSONBootTest/.gitignore renamed to APIJSON-Java-Server/APIJSONDemo/.gitignore

@@ -1,4 +1,7 @@
+# APIJSONFinal
 
-#### 运行
+APIJSON + JFinal 接近成品的 Demo
 
-右键 AppRunnableConfig > Run As > Java Application
+### 运行
+
+右键 DemoAppConfig > Run As > Java Application

APIJSON-Java-Server/APIJSONDemo/README.md

@@ -21,15 +21,15 @@
 		</dependency>
 
 		<!-- 可使用 libs 目录的 apijson-orm.jar 和 apijson-framework.jar 来替代，两种方式二选一 <<<<<<<<<< -->
-		<dependency>
+	 	<dependency>
 			<groupId>com.github.Tencent</groupId>
 			<artifactId>APIJSON</artifactId>
-			<version>4.2.4</version>
+			<version>4.2.5</version>
 		</dependency>
 		<dependency>
 			<groupId>com.github.APIJSON</groupId>
 			<artifactId>apijson-framework</artifactId>
-			<version>4.4.0</version>
+			<version>4.4.3</version>
 		</dependency>
 		<!-- 可使用 libs 目录的 apijson-orm.jar 和 apijson-framework.jar 来替代，两种方式二选一 >>>>>>>>>> -->
 
@@ -148,7 +148,7 @@
 							<transformers>
 								<transformer
 									implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
-									<mainClass>apijson.jfinal.AppRunnableConfig</mainClass>
+									<mainClass>apijson.jfinal.DemoAppConfig</mainClass>
 								</transformer>
 
 								<!-- 下面的配置支持排除指定文件打包到 jar 之中，可以用于排除需要修改的配置文件以便于在外部的 config 目录下的 同名配置文件生效，建议使用 

APIJSON-Java-Server/APIJSONBootTest/pom.xml renamed to APIJSON-Java-Server/APIJSONDemo/pom.xml

@@ -41,8 +41,13 @@ public DemoSQLConfig(RequestMethod method, String table) {
 		DEFAULT_DATABASE = DATABASE_MYSQL;  //TODO 默认数据库类型，改成你自己的
 		DEFAULT_SCHEMA = "sys";  //TODO 默认模式名，改成你自己的，默认情况是 MySQL: sys, PostgreSQL: public, SQL Server: dbo, Oracle: 
 
-		//  由 DemoVerifier.init 方法读取数据库 Access 表来替代手动输入配置
-		//		//表名映射，隐藏真实表名，对安全要求很高的表可以这么做
+		//表名和数据库不一致的，需要配置映射关系。只使用 APIJSONORM 时才需要；
+		//这个 Demo 用了 apijson-framework 且调用了 APIJSONApplication.init
+		//(间接调用 DemoVerifier.init 方法读取数据库 Access 表来替代手动输入配置)，所以不需要。
+		//但如果 Access 这张表的对外表名与数据库实际表名不一致，仍然需要这里注册。例如
+		//		TABLE_KEY_MAP.put(Access.class.getSimpleName(), "access");
+
+		//表名映射，隐藏真实表名，对安全要求很高的表可以这么做
 		//		TABLE_KEY_MAP.put(User.class.getSimpleName(), "apijson_user");
 		//		TABLE_KEY_MAP.put(Privacy.class.getSimpleName(), "apijson_privacy");
 
@@ -162,6 +167,12 @@ public String getDBPassword() {
 		return null;
 	}
 
+	//取消注释后，默认的 APIJSON 配置表会由业务表所在数据库模式 schema 改为自定义的
+	//	@Override
+	//	public String getConfigSchema() {
+	//		return "apijson";
+	//	}
+
 	//取消注释后，默认的数据库类型会由 MySQL 改为 PostgreSQL
 	//	@Override
 	//	public String getDatabase() {

APIJSON-Java-Server/APIJSONBootTest/src/main/java/apijson/boot/test/DemoApplication.java renamed to APIJSON-Java-Server/APIJSONDemo/src/main/java/apijson/demo/DemoApplication.java

@@ -53,7 +53,7 @@
  * 右键这个类 > Run As > Java Application
  * @author Lemon
  */
-public class AppRunnableConfig extends JFinalConfig {
+public class DemoAppConfig extends JFinalConfig {
 
 	static {
 		// APIJSON 配置 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
@@ -96,7 +96,7 @@ public SQLExecutor createSQLExecutor() {
 
 
 	public static void main(String[] args) throws Exception {
-		UndertowServer.start(AppRunnableConfig.class);
+		UndertowServer.start(DemoAppConfig.class);
 
 		Log.DEBUG = true;  // 上线生产环境前改为 false，可不输出 APIJSONORM 的日志 以及 SQLException 的原始(敏感)信息
 		APIJSONApplication.init();