diff --git a/README.md b/README.md index ae95355..9c4fea2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ # demo-embed-request-filter -embed filter接口demo \ No newline at end of file +embed filter接口demo\ +Demo示例简单展示了该接口的最基本的用法 +NextDemo示例用于指明同一插件中多个embed filter接口的执行顺序 +ErrorDemo示例则展示了该接口的错误用法 \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..3d3e2c4 --- /dev/null +++ b/build.gradle @@ -0,0 +1,124 @@ + +apply plugin: 'java' + +[compileJava,compileTestJava]*.options*.encoding = 'UTF-8' + +ext { + /** + * 项目中依赖的jar的路径 + * 1.如果依赖的jar需要打包到zip中,放置在lib根目录下 + * 2.如果依赖的jar仅仅是编译时需要，防止在lib下子目录下即可 + */ + libPath = "$projectDir/../webroot/WEB-INF/lib" + + /** + * 是否对插件的class进行加密保护，防止反编译 + */ + guard = false + + def pluginInfo = getPluginInfo() + pluginPre = "fine-plugin" + pluginName = pluginInfo.id + pluginVersion = pluginInfo.version + + outputPath = "$projectDir/../webroot/WEB-INF/plugins/plugin-" + pluginName + "-1.0/classes" +} + +group = 'com.fr.plugin' +version = '10.0' +sourceCompatibility = '8' + +sourceSets { + main { + java.outputDir = file(outputPath) + output.resourcesDir = file(outputPath) + } +} + +ant.importBuild("encrypt.xml") +//定义ant变量 +ant.projectDir = projectDir +ant.references["compile.classpath"] = ant.path { + fileset(dir: libPath, includes: '**/*.jar') + fileset(dir: ".",includes:"**/*.jar" ) +} + +classes.dependsOn('clean') + +task copyFiles(type: Copy,dependsOn: 'classes'){ + from outputPath + into "$projectDir/classes" +} + +task preJar(type:Copy,dependsOn: guard ? 'compile_encrypt_javas' : 'compile_plain_javas'){ + from "$projectDir/classes" + into "$projectDir/transform-classes" + include "**/*.*" +} +jar.dependsOn("preJar") + +task makeJar(type: Jar,dependsOn: preJar){ + from fileTree(dir: "$projectDir/transform-classes") + baseName pluginPre + appendix pluginName + version pluginVersion + destinationDir = file("$buildDir/libs") + + doLast(){ + delete file("$projectDir/classes") + delete file("$projectDir/transform-classes") + } +} + +task copyFile(type: Copy,dependsOn: ["makeJar"]){ + from "$buildDir/libs" + from("$projectDir/lib") { + include "*.jar" + } + from "$projectDir/plugin.xml" + into file("$buildDir/temp/plugin") +} + +task zip(type:Zip,dependsOn:["copyFile"]){ + from "$buildDir/temp/plugin" + destinationDir file("$buildDir/install") + baseName pluginPre + appendix pluginName + version pluginVersion +} + +//控制build时包含哪些文件,排除哪些文件 +processResources { +// exclude everything +// 用*.css没效果 +// exclude '**/*.css' +// except this file +// include 'xx.xml' +} + +/*读取plugin.xml中的version*/ +def getPluginInfo(){ + def xmlFile = file("plugin.xml") + if (!xmlFile.exists()) { + return ["id":"none", "version":"1.0.0"] + } + def plugin = new XmlParser().parse(xmlFile) + def version = plugin.version[0].text() + def id = plugin.id[0].text() + return ["id":id,"version":version] +} + +repositories { + mavenLocal() + maven { + url = uri('http://mvn.finedevelop.com/repository/maven-public/') + } +} + +dependencies { + //使用本地jar + implementation fileTree(dir: 'lib', include: ['**/*.jar']) + implementation fileTree(dir: libPath, include: ['**/*.jar']) +} + + diff --git a/encrypt.xml b/encrypt.xml new file mode 100644 index 0000000..1401cd1 --- /dev/null +++ b/encrypt.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/lib/common-kit-10.0-20210309.jar b/lib/common-kit-10.0-20210309.jar new file mode 100644 index 0000000..7027142 Binary files /dev/null and b/lib/common-kit-10.0-20210309.jar differ diff --git a/lib/finekit-10.0-20210309.jar b/lib/finekit-10.0-20210309.jar new file mode 100644 index 0000000..2d3b5b4 Binary files /dev/null and b/lib/finekit-10.0-20210309.jar differ diff --git a/plugin.xml b/plugin.xml new file mode 100644 index 0000000..6d476be --- /dev/null +++ b/plugin.xml @@ -0,0 +1,18 @@ + + com.tptj.demo.hg.embed.request.filter.v10 + + yes + 1.0 + 10.0 + tptj + 2019-07-18 + + + com.tptj.demo.hg.embed.request.filter + + + + + + + \ No newline at end of file diff --git a/src/main/java/com/tptj/demo/hg/embed/request/filter/Demo.java b/src/main/java/com/tptj/demo/hg/embed/request/filter/Demo.java new file mode 100644 index 0000000..b280225 --- /dev/null +++ b/src/main/java/com/tptj/demo/hg/embed/request/filter/Demo.java @@ -0,0 +1,26 @@ +package com.tptj.demo.hg.embed.request.filter; + +import com.fanruan.api.log.LogKit; +import com.fr.decision.fun.impl.AbstractEmbedRequestFilterProvider; +import com.fr.intelli.record.Focus; +import com.fr.record.analyzer.EnableMetrics; +import com.fr.web.utils.WebUtils; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * @author 秃破天际 + * @version 10.0 + * Created by 秃破天际 on 2021-03-26 + **/ +@EnableMetrics +public class Demo extends AbstractEmbedRequestFilterProvider { + @Override + @Focus(id = "com.tptj.demo.hg.embed.request.filter.v10",text = "embed filter") + public void filter(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + LogKit.info( "EmbedRequestFilter:path={},ip={}", request.getPathInfo(), WebUtils.getIpAddr(request) ); + } +} diff --git a/src/main/java/com/tptj/demo/hg/embed/request/filter/ErrorDemo.java b/src/main/java/com/tptj/demo/hg/embed/request/filter/ErrorDemo.java new file mode 100644 index 0000000..9c41b35 --- /dev/null +++ b/src/main/java/com/tptj/demo/hg/embed/request/filter/ErrorDemo.java @@ -0,0 +1,24 @@ +package com.tptj.demo.hg.embed.request.filter; + +import com.fr.decision.fun.impl.AbstractEmbedRequestFilterProvider; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * @author 秃破天际 + * @version 10.0 + * Created by 秃破天际 on 2021-03-26 + * 这是一个错误的示例！在这个接口中如果对响应做了输出性质的动作，则后续逻辑就会报错 + * 因为此接口除了报错外无法终止其他filter的允许也无法终止后续产品逻辑的运行 + **/ +public class ErrorDemo extends AbstractEmbedRequestFilterProvider { + + + @Override + public void filter(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + response.sendRedirect("https://www.baidu.com/"); + } +} \ No newline at end of file diff --git a/src/main/java/com/tptj/demo/hg/embed/request/filter/NextDemo.java b/src/main/java/com/tptj/demo/hg/embed/request/filter/NextDemo.java new file mode 100644 index 0000000..a089d8c --- /dev/null +++ b/src/main/java/com/tptj/demo/hg/embed/request/filter/NextDemo.java @@ -0,0 +1,25 @@ +package com.tptj.demo.hg.embed.request.filter; + +import com.fanruan.api.log.LogKit; +import com.fr.decision.fun.impl.AbstractEmbedRequestFilterProvider; +import com.fr.web.utils.WebUtils; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * @author 秃破天际 + * @version 10.0 + * Created by 秃破天际 on 2021-03-26 + * 该demo展示了，多个Embed filter是可以同时生效的。在不抛错的前提下相互独立。 + * 且同一插件内，多个Embed filter的执行顺序为先在plugin.xml中申明的先执行 + **/ +public class NextDemo extends AbstractEmbedRequestFilterProvider { + + @Override + public void filter(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + LogKit.info( "NextFilter:path={},ip={}", request.getPathInfo(), WebUtils.getIpAddr(request) ); + } +}