简介

本文将介绍如何编写一个提供给后台接口并使用脚本在前端页面调用。

使用maven下载XWiki提供的模板项目

保证你的maven已经安装，然后执行命令

mvn archetype:generate \-DarchetypeArtifactId=xwiki-commons-component-archetype \-DarchetypeGroupId=org.xwiki.commons \-DarchetypeVersion=10.11.3

下载成功之后会询问项目的自定义预设信息

当你输入’Y’确认了以后就会在本地生成项目了
模板项目里边的文件列表如下

pom.xml
src/main/java/com/fxp/HelloWorld.java
src/main/java/com/fxp/internal/DefaultHelloWorld.java
src/main/java/com/fxp/internal/HelloWorldScriptService.java
src/main/resources/META-INF/components.txt
src/test/java/com/fxp/HelloWorldTest.java

介绍几个比较重要的文件

components.txt：用于实例的注入，你编写的bean都要在此文件中声明才能注入到应用上下文中。
HelloWorldScriptService.java：用于把你的bean暴露给前端页面的脚本，脚本可以通过services对象找到你的bean。

如何写一个bean并且暴露给前端页面

第一步：编写你的bean

package com.fxp.internal;import com.fxp.HelloWorld;
import org.xwiki.component.annotation.Component;
import javax.inject.Singleton;/*** Implementation of a <tt>HelloWorld</tt> component.*/
@Component
@Singleton
public class DefaultHelloWorld implements HelloWorld
{@Overridepublic String sayHello(){return "hello I come from custom jar!!";}
}

第二步：在components.txt中声明你的bean

com.fxp.internal.DefaultHelloWorld
com.fxp.script.HelloWorldScriptService

第三步：注入到ScriptService的bean中，通过该bean的方法暴露出去。

package com.fxp.script;import org.xwiki.component.annotation.Component;
import org.xwiki.script.service.ScriptService;import com.fxp.HelloWorld;import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Singleton;/*** Make the HelloWorld API available to scripting.*/
@Component
@Named("hello")
@Singleton
public class HelloWorldScriptService implements ScriptService
{@Injectprivate HelloWorld helloWorld;public String greet(){return this.helloWorld.sayHello();}
}

把项目打成jar包并且导入到XWiki中

在项目目录下使用mvn install命令生成jar包，如果成功可以在打印信息的最后看到生成的jar包目录，如下

再把jar包复制到XWiki应用的lib目录下

#我是用docker部署的，所以要用docker cp命令
docker cp C:\Users\Administrator\.m2\repository\com\fxp\test-component\1.0-SNAPSHOT\test-component-1.0-SNAPSHOT.jar 747f836b8a05:/usr/local/tomcat/webapps/ROOT/WEB-INF/lib

重启XWiki项目

到此，jar包部署完成，下一步测试一下我们的jar包。

在前端使用脚本访问你的接口

我们编写的ScriptService的bean方法可以在前端脚本中使用services对象引用到，在XWiki编辑框中输入如下脚本（hello就是我们使用@Named(“hello”)声明的对bean名称）

点击保存并查看，效果如下

总结

到此，从后端API到前端脚本的流程都打通了。

XWiki开发指南3-自定义扩展jar包相关推荐

jmeter 导入java,JMeter导入自定义的Jar包的详解教程
1.简介原计划这一篇是介绍前置处理器的基础知识的,结果由于许多小伙伴或者童鞋们在微信和博客园的短消息中留言问如何引入自己定义的Jar包呢???我一一回复告诉他们和引入插件的Jar包一样的道理,一通百 ...
Android系统（20）---开发android项目的常用jar包
1. 百度地图 Armeabi/libBaiduMapSDK_v3_4_0_15.so, libBMapApiEngine.so baidumapapi_v3_4_9.jar(demo),locSDK ...
Android安卓开发-eclipse正确添加第三方jar包
本文转载自http://www.cnblogs.com/developerY/archive/2013/04/18/3027997.html,在此对原作者表示感谢! 在android项目中添加第三方j ...
xwiki开发指南1-使用XWiki创建FAQ应用
本文是按照XWiki官网开发指南-FAQ应用创建,自己翻译总结的版本. 此篇含有大量图片,关于XWiki的开发,将在下一篇讲解. 关于XWiki的部署也会单独写一篇基于docker的部署文. 使用XW ...
SpringBoot项目开发(十)：引用本地jar包与打包本地jar
标题可能有点绕口,在实际开发中,有时所引用的jar架包无法在 maven 中央仓库里找到,那么j就要引用本地jar包,然而在项目开发完成后,需要打包部署时,引用的本地jar包没有打包进去部署包,就会导 ...
Java开发过程中开发工具Eclipse中导入jar包的过程
欢迎欣赏我的第二篇随笔.我们在创建好一个动态网站项目之后,如果没有部署maven的情况下,你可以按照以下的方法,直接把要用的jar包导入你的工程中,而不用再部署maven. 例如在使用JDBC编程时需 ...
如何在eclipse中自定义一个jar包名称
第一步:选择 Add Library 第二步:选择User Library 第三步: 第四步:添加下载好的jar包这样自己定义的包名和导包就完全了.
在WEB开发的时候导入各种jar包
使用eclipse导入很简单右击你的project,选择properties,然后选择java build path,接着选择libraries,点击add external jars即可如果你还 ...
android中将自己的自定义组件打成JAR包
在项目开发过程中,我们难免会用到自己去制作自定义的VIEW控件,之后我们别的项目如果需要的话就直接将其复制到对应的项目中使用,虽说这么做是一个解决问题的方法,但毕竟不是很好. 原因是,当我们项目积累越 ...

XWiki开发指南3-自定义扩展jar包

简介

使用maven下载XWiki提供的模板项目

如何写一个bean并且暴露给前端页面

把项目打成jar包并且导入到XWiki中

在前端使用脚本访问你的接口

总结

XWiki开发指南3-自定义扩展jar包相关推荐

最新文章

热门文章