Skip to content

Commit fa55171

Browse files
cloudAndMonkeycloudAndMonkey
authored
apijson function支持脚本引擎，比如JavaScript、lua等
Tencent/APIJSON#495
1 parent e323cce commit fa55171

13 files changed

+698
-0
lines changed

‎APIJSON-Java-Server/APIJSONDemo-Script/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# APIJSONDemo
2+
3+
APIJSON + SpringBoot 初级使用的最简单 Demo
4+
5+
### 运行
6+
7+
右键 DemoApplication > Run As > Java Application

‎APIJSON-Java-Server/APIJSONDemo-Script/pom.xml

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
4+
<modelVersion>4.0.0</modelVersion>
5+
<groupId>apijson.demo</groupId>
6+
<artifactId>apijson-demo-script</artifactId>
7+
<version>6.0.0</version>
8+
<packaging>jar</packaging>
9+
10+
<name>APIJSONDemo-Druid</name>
11+
<description>Demo project for Testing APIJSON Server based on SpringBoot</description>
12+
13+
<properties>
14+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
15+
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
16+
<java.version>1.8</java.version>
17+
<graalvm.version>21.3.3.1</graalvm.version>
18+
<lombok.version>1.18.4</lombok.version>
19+
</properties>
20+
21+
<dependencies>
22+
<!-- JDK 11+ 需要，否则启动报错 NoClassDefFoundError: javax/activation/UnsupportedDataTypeException -->
23+
<dependency>
24+
<groupId>javax.activation</groupId>
25+
<artifactId>activation</artifactId>
26+
<version>1.1.1</version>
27+
</dependency>
28+
<!-- 需要的 APIJSON 相关依赖 -->
29+
<dependency>
30+
<groupId>com.github.APIJSON</groupId>
31+
<artifactId>apijson-framework</artifactId>
32+
<version>6.0.0</version>
33+
</dependency>
34+
35+
<!-- 需要用的数据库 JDBC 驱动 -->
36+
<dependency>
37+
<groupId>mysql</groupId>
38+
<artifactId>mysql-connector-java</artifactId>
39+
<version>8.0.29</version>
40+
</dependency>
41+
<dependency>
42+
<groupId>org.postgresql</groupId>
43+
<artifactId>postgresql</artifactId>
44+
<version>42.3.4</version>
45+
</dependency>
46+
<!-- Oracle, SQLServer 等其它数据库的 JDBC 驱动，可以在这里加上 Maven 依赖或 libs 目录放 Jar 包并依赖 -->
47+
48+
<!-- 需要用的 SpringBoot 框架，1.4.0 以上 -->
49+
<dependency>
50+
<groupId>org.springframework.boot</groupId>
51+
<artifactId>spring-boot-starter-web</artifactId>
52+
<version>2.5.13</version>
53+
</dependency>
54+
55+
<!-- 需要用的 Druid 数据库连接池库，1.0.29 以上 -->
56+
<dependency>
57+
<groupId>com.alibaba</groupId>
58+
<artifactId>druid</artifactId>
59+
<version>1.2.9</version>
60+
</dependency>
61+
<dependency>
62+
<groupId>org.graalvm.js</groupId>
63+
<artifactId>js</artifactId>
64+
<version>${graalvm.version}</version>
65+
</dependency>
66+
<dependency>
67+
<groupId>org.projectlombok</groupId>
68+
<artifactId>lombok</artifactId>
69+
<version>${lombok.version}</version>
70+
</dependency>
71+
</dependencies>
72+
73+
<build>
74+
<plugins>
75+
<plugin>
76+
<groupId>org.springframework.boot</groupId>
77+
<artifactId>spring-boot-maven-plugin</artifactId>
78+
<configuration>
79+
<fork>true</fork>
80+
<mainClass>apijson.demo.DemoApplication</mainClass>
81+
</configuration>
82+
<executions>
83+
<execution>
84+
<goals>
85+
<goal>repackage</goal>
86+
</goals>
87+
</execution>
88+
</executions>
89+
</plugin>
90+
<plugin>
91+
<groupId>org.apache.maven.plugins</groupId>
92+
<artifactId>maven-compiler-plugin</artifactId>
93+
<configuration>
94+
<source>1.8</source>
95+
<target>1.8</target>
96+
</configuration>
97+
</plugin>
98+
</plugins>
99+
</build>
100+
101+
<repositories>
102+
<!-- APIJSON 必须用到的托管平台 -->
103+
<repository>
104+
<id>jitpack.io</id>
105+
<url>https://jitpack.io</url>
106+
<snapshots>
107+
<enabled>true</enabled>
108+
</snapshots>
109+
</repository>
110+
111+
<repository>
112+
<id>spring-snapshots</id>
113+
<url>https://repo.spring.io/snapshot</url>
114+
<snapshots>
115+
<enabled>true</enabled>
116+
</snapshots>
117+
</repository>
118+
<repository>
119+
<id>spring-milestones</id>
120+
<url>https://repo.spring.io/milestone</url>
121+
</repository>
122+
</repositories>
123+
124+
</project>

‎APIJSON-Java-Server/APIJSONDemo-Script/src/main/java/apijson/demo/DemoApplication.java

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
/*Copyright ©2016 TommyLemon(https://github.com/TommyLemon/APIJSON)
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.*/
14+
15+
package apijson.demo;
16+
17+
import org.springframework.boot.SpringApplication;
18+
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
19+
import org.springframework.boot.autoconfigure.SpringBootApplication;
20+
import org.springframework.boot.context.properties.EnableConfigurationProperties;
21+
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
22+
import org.springframework.boot.web.servlet.server.ConfigurableServletWebServerFactory;
23+
import org.springframework.context.ApplicationContext;
24+
import org.springframework.context.annotation.Bean;
25+
import org.springframework.context.annotation.Configuration;
26+
import org.springframework.web.servlet.config.annotation.CorsRegistry;
27+
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
28+
29+
import apijson.Log;
30+
import apijson.demo.script.GraalJavaScriptExecutor;
31+
import apijson.demo.script.LuaScriptExecutor;
32+
import apijson.demo.script.NashornScriptExecutor;
33+
import apijson.framework.APIJSONApplication;
34+
import apijson.framework.APIJSONCreator;
35+
import apijson.orm.SQLConfig;
36+
import apijson.orm.SQLExecutor;
37+
import apijson.orm.script.ScriptExecutor;
38+
39+
/**
40+
* Demo SpringBoot Application 主应用程序启动类 右键这个类 > Run As > Java Application 具体见
41+
* SpringBoot 文档
42+
* https://www.springcloud.cc/spring-boot.html#using-boot-locating-the-main-class
43+
*
44+
* @author Lemon
45+
*/
46+
@Configuration
47+
@SpringBootApplication
48+
@EnableAutoConfiguration
49+
@EnableConfigurationProperties
50+
public class DemoApplication implements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> {
51+
52+
// 全局 ApplicationContext 实例，方便 getBean 拿到 Spring/SpringBoot 注入的类实例
53+
private static ApplicationContext APPLICATION_CONTEXT;
54+
55+
public static ApplicationContext getApplicationContext() {
56+
return APPLICATION_CONTEXT;
57+
}
58+
59+
public static void main(String[] args) throws Exception {
60+
APPLICATION_CONTEXT = SpringApplication.run(DemoApplication.class, args);
61+
62+
Log.DEBUG = true;
63+
// 加载扩展脚本执行器
64+
extendScriptExecutor();
65+
APIJSONApplication.init(true); // 4.4.0 以上需要这句来保证以上 static 代码块中给 DEFAULT_APIJSON_CREATOR 赋值会生效
66+
}
67+
68+
public static void extendScriptExecutor() {
69+
ScriptExecutor javaScriptExecutor = new NashornScriptExecutor();
70+
ScriptExecutor luaExecutor = new LuaScriptExecutor();
71+
ScriptExecutor GraalJSExecutor = new GraalJavaScriptExecutor();
72+
APIJSONApplication.addScriptExecutor("nashornJS", javaScriptExecutor);
73+
APIJSONApplication.addScriptExecutor("luaj", luaExecutor);
74+
APIJSONApplication.addScriptExecutor("graalJS", GraalJSExecutor);
75+
}
76+
77+
// SpringBoot 2.x 自定义端口方式
78+
@Override
79+
public void customize(ConfigurableServletWebServerFactory server) {
80+
server.setPort(8080);
81+
}
82+
83+
// 支持 APIAuto 中 JavaScript 代码跨域请求
84+
@Bean
85+
public WebMvcConfigurer corsConfigurer() {
86+
return new WebMvcConfigurer() {
87+
@Override
88+
public void addCorsMappings(CorsRegistry registry) {
89+
registry.addMapping("/**").allowedOriginPatterns("*").allowedMethods("*").allowCredentials(true).maxAge(3600);
90+
}
91+
};
92+
}
93+
94+
static {
95+
// 使用本项目的自定义处理类
96+
APIJSONApplication.DEFAULT_APIJSON_CREATOR = new APIJSONCreator<Long>() {
97+
@Override
98+
public SQLConfig createSQLConfig() {
99+
return new DemoSQLConfig();
100+
}
101+
102+
@Override
103+
public SQLExecutor createSQLExecutor() {
104+
return new DemoSQLExecutor();
105+
}
106+
};
107+
108+
// 把以下需要用到的数据库驱动取消注释即可，如果这里没有可以自己新增
109+
// try { //加载驱动程序
110+
// Log.d(TAG, "尝试加载 SQLServer 驱动 <<<<<<<<<<<<<<<<<<<<< ");
111+
// Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
112+
// Log.d(TAG, "成功加载 SQLServer 驱动！>>>>>>>>>>>>>>>>>>>>> ");
113+
// }
114+
// catch (ClassNotFoundException e) {
115+
// e.printStackTrace();
116+
// Log.e(TAG, "加载 SQLServer 驱动失败，请检查 pom.xml 中 net.sourceforge.jtds 版本是否存在以及可用
117+
// ！！！");
118+
// }
119+
//
120+
// try { //加载驱动程序
121+
// Log.d(TAG, "尝试加载 Oracle 驱动 <<<<<<<<<<<<<<<<<<<<< ");
122+
// Class.forName("oracle.jdbc.driver.OracleDriver");
123+
// Log.d(TAG, "成功加载 Oracle 驱动！>>>>>>>>>>>>>>>>>>>>> ");
124+
// }
125+
// catch (ClassNotFoundException e) {
126+
// e.printStackTrace();
127+
// Log.e(TAG, "加载 Oracle 驱动失败，请检查 pom.xml 中 com.oracle.jdbc 版本是否存在以及可用 ！！！");
128+
// }
129+
130+
}
131+
132+
}

‎APIJSON-Java-Server/APIJSONDemo-Script/src/main/java/apijson/demo/DemoController.java

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
/*Copyright ©2016 TommyLemon(https://github.com/TommyLemon/APIJSON)
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.*/
14+
15+
package apijson.demo;
16+
17+
import java.net.URLDecoder;
18+
import java.util.Map;
19+
20+
import javax.servlet.http.HttpSession;
21+
22+
import org.springframework.web.bind.annotation.GetMapping;
23+
import org.springframework.web.bind.annotation.PathVariable;
24+
import org.springframework.web.bind.annotation.PostMapping;
25+
import org.springframework.web.bind.annotation.RequestBody;
26+
import org.springframework.web.bind.annotation.RequestMapping;
27+
import org.springframework.web.bind.annotation.RequestParam;
28+
import org.springframework.web.bind.annotation.RestController;
29+
30+
import apijson.RequestMethod;
31+
import apijson.StringUtil;
32+
import apijson.framework.APIJSONController;
33+
import apijson.orm.Parser;
34+
35+
36+
/**请求路由入口控制器，包括通用增删改查接口等，转交给 APIJSON 的 Parser 来处理
37+
* 具体见 SpringBoot 文档
38+
* https://www.springcloud.cc/spring-boot.html#boot-features-spring-mvc
39+
* 以及 APIJSON 通用文档 3.设计规范 3.1 操作方法
40+
* https://github.com/Tencent/APIJSON/blob/master/Document.md#3.1
41+
* <br > 建议全通过HTTP POST来请求:
42+
* <br > 1.减少代码 - 客户端无需写HTTP GET,PUT等各种方式的请求代码
43+
* <br > 2.提高性能 - 无需URL encode和decode
44+
* <br > 3.调试方便 - 建议使用 APIAuto(http://apijson.cn/api) 或 Postman
45+
* @author Lemon
46+
*/
47+
@RestController
48+
@RequestMapping("")
49+
public class DemoController extends APIJSONController<Long> {
50+
51+
@Override
52+
public Parser<Long> newParser(HttpSession session, RequestMethod method) {
53+
return super.newParser(session, method).setNeedVerify(false); // TODO 这里关闭校验，方便新手快速测试，实际线上项目建议开启
54+
}
55+
56+
/**增删改查统一接口，这个一个接口可替代 7 个万能通用接口，牺牲一些路由解析性能来提升一点开发效率
57+
* @param method
58+
* @param request
59+
* @param session
60+
* @return
61+
*/
62+
@PostMapping(value = "{method}") // 如果和其它的接口 URL 冲突，可以加前缀，例如改为 crud/{method} 或 Controller 注解 @RequestMapping("crud")
63+
@Override
64+
public String crud(@PathVariable String method, @RequestBody String request, HttpSession session) {
65+
return super.crud(method, request, session);
66+
}
67+
68+
/**增删改查统一接口，这个一个接口可替代 7 个万能通用接口，牺牲一些路由解析性能来提升一点开发效率
69+
* @param method
70+
* @param tag
71+
* @param params
72+
* @param request
73+
* @param session
74+
* @return
75+
*/
76+
@PostMapping("{method}/{tag}") // 如果和其它的接口 URL 冲突，可以加前缀，例如改为 crud/{method}/{tag} 或 Controller 注解 @RequestMapping("crud")
77+
@Override
78+
public String crudByTag(@PathVariable String method, @PathVariable String tag, @RequestParam Map<String, String> params, @RequestBody String request, HttpSession session) {
79+
return super.crudByTag(method, tag, params, request, session);
80+
}
81+
82+
/**获取
83+
* 只为兼容HTTP GET请求，推荐用HTTP POST，可删除
84+
* @param request 只用String，避免encode后未decode
85+
* @param session
86+
* @return
87+
* @see {@link RequestMethod#GET}
88+
*/
89+
@GetMapping("get/{request}")
90+
public String openGet(@PathVariable String request, HttpSession session) {
91+
try {
92+
request = URLDecoder.decode(request, StringUtil.UTF_8);
93+
} catch (Exception e) {
94+
// Parser 会报错
95+
}
96+
return get(request, session);
97+
}
98+
99+
}

0 commit comments

Comments
 (0)