tigase开发指南

1、tigase开发指南tigase组件插件配置tigase启动时会初始化并启动相关组件与插件，启动的组件或开通监听端口号或访问数据库或者创建线程池，默认有些组件与插件非必须，我们也用不到，为了避免资源浪费，需要在配置中注释这些组件组件如下表格所示，红字的组件说明tigase组件说明Amp高级消息处理Bosh提供客户端http长连接c2s提供客户端tcp连接cl-comp内置集群组件eventbus事件总线，内部处理message-archive消息归档monitor监控muc聊天室proxy代理pubsub发布订阅s2stigase服务端节点之间交互sess-man会话管理配置文件配置启动组件修

2、改init、propertiesmessage-router/components/msg-receivers/id-namess=bosh,cl-comp,eventbus,s2s,sess-man插件如下表格所示，红字的插件说明tigas插件说明参数说明jabber:iq:register注册服务message-archive-xep-0136消息归档jabber:iq:auth简单用户认证urn:ietf:params:xml:ns:xmpp-saslSASL协商urn:ietf:params:xml:ns:xmpp-bind资源绑定urn:ietf:params:xml:ns:xmpp

3、-sessionsession绑定jabber:iq:roster联系人名单管理presence-statexmpp顶级兀素，上线广播jabber:iq:privacy隐身协议jabber:iq:version客户端版本就是否发送统计信息，指向jabber、org发送startlstls加密msgoffline离线消息vcard-temp临时的vCard管理virtualdomains的特别命令jabber:iq:private私有数据存储urn:xmpp:ping心跳检测presence-subscription发布订阅插件domain-filter(basic-filter)domain拦

4、截器amp(basic-filter)高级消息处理zlib(basic-filter)zlib压缩message-carbons(basic-filter)将stanzas投递到用户指定的资源disco(basic-filter)服务发现配置文件配置启动组件：修改init、propertiessess-man/pluginss=session-closesession-open,default-handler,urn:ietf:params:xml:ns:xmpp-sasl,urn:ietf:params:xml:ns:xmpp-bind,urn:ietf:params:xml:ns:xmpp

5、-session,jabber:iq:roster,Tigase数据库表Tigase用户信息、权限信息、离线消息信息、在线离线状态信息都存储在数据库中，但有些数据我们不需要让tigagse存储、更新，比如在线离线状态信息，如果每个用户登录、登出都让tigase更新表的字段，并发高了，显然数据库承受不了。为了避免资源浪费也需要避免这些登录状态上线更新登录状态下线更新上线状态更新就是在验证用户名与密码时更新，验证功能就是需要我们自定义的，仅需修改tigase验证模块的一小块代码即可。下图贴出tigase源码修改方式J叫山A«rMeMiPI|irCVif八protwtcdwid'h

6、wltfVen,fyftB»Rc<allb«ck(yerifyFci55iwna£flllbockpc)IQEmception(String叩弓Ed.pc,聚上PfKsnprdQ噂。(Mcip-rStriflo,.bjKt>m.rwHosl*lQ|xltrinQ,Cbjtct>O；catchCE»cfpticnf)mBMtverifiedfffllw;Nj-il9na-VTiwM.um*!>:qdltJuEJFPC*ll»EHElK/kpJ.JbttCfcl-MinEi'MfriVJ-ILsmefjtIpw1耳1

7、.3山1=ERI，祈*的十IIWQQH晔nrwwwa、1,«<TWnEr<.1l«MjC#WpWL44MwtiM7UC.ZQmpGTCrr-niKlJE5卜电Eldezl*曲13hIFDd£l!"iPTpi4；IF*5k.,-：.-arrarr*L_rtb,f,J11lgHi.cBni加ija由iw匕知tjmQ工llgfi.dkeaV函laMgug三Ru.midX知Bueig*鼾Zm-ih2il«Kr>Tin*n打工刖口力1!¥让IIfMIIIfig.loflClevtl.FJWSLc,rifyP口号-mhtedcW

8、.thrflwfWwiiOExcepticr"PaiemficJ：1V已产.Ficationpreblefl.,ej;jabber:iq:privacy,jabber:iq:version,starttls,vcard-temp,jabber:iq:private,urn:xmpp:ping,amp,disco,domain-filter,zlib,message-carbonsvcard-xep-0292,urn:xmpp:timeWp.piitCAuthHcpositoryfflDTOtdLfcEF.AuthRepository,PRTXtA_VALlop.pktCAkUiRep

9、osibory-USffL肛JCEi%id;flap.purtCAhitJlRepfrsitOI7.NLWD_K£rfRS1sd工wp.feory/日DUJHL*E%j闻.gel&mai*K)XupvtCjkrthite|M4ifecry,我碓工江/jid.处tOemiHO);日女网户松,不胃*国即叮不1,可立育户/BSSUiEy7庇蚯可以1占为调用科阳暴星rest楼=1pcsetwerifiPUMtJ;下线状态更新就是在用户退出、连接断开等时更新，修改代码也比较简单上七注峰挂七可鼻1聘(if口中JM*pjdautLWi/zm闻j&acm.F1厘a心Mgrmxiw：睥

10、?”s/1«O”出/Bith_rirpfiSif-nry,1grajtCuPPJi曰q511口口;1F(Ifjg.LiLCk®l±514|CLtwlBJJW-10)(trhngfluildc*15旭，StTtngBu，idirO岫九few*EXM呻psfiurtzefcmnetitiGn产陌je：1cn-getA£tt¥*R«sjr£K(J)虫，<WT13are5-",)ia?pan<res_c(x.getilesDLrceOl;)的JMIUM局"liftergwctiwe网"”wu

11、i«r田。mmOlijtctD5si0rgetAckiKourcfqSiztC)ukl讪mtoSE也1);J"EOfflbC"wdMH1in.tActIwcRruxirLF4Stx«()一BQ)cmch(NotJkittorizedfjccefinri)Fb.ImfLrwI.1rMHT-rwtdbnri/adqwiiVT-lilV.事、二tigase权限验证云果登陆流程时需要验证权限，权限验证需要分匿名用户与企业客服两种，匿名用户默认验证都可以通过，企业客服需要验证就是否在用户中心登陆成功。企业客服登陆1、登陆用户中心，登陆成功后，用户中心会保存cook

12、ieid至缓存中2、带着用户名、cookieid同tigase服务端建立连接3、从缓存中获取验证信息4、如果认证通过与tigase连接上tigase的验证就是需要我们自定义开发的，只需要在tigase权限验证模块修改即可。卧atfQdQQq 由Jaqaq".-zfed4.d!l5r E一一一mEiipwMxi 'i- L- r K- L- L 产“l-l:l;-i LriJL i'=_r L 4 J i- > ，盅邮WB卸。一知ftl由elw由却町叫8司即的中4!'» ''1 - I" "!pEtwtcd m

13、id 'horeilifVein,fyRo55Mxc<allb<!ck(Vmfy<1ci55iw,SCnllbock pc) thnam QC*eption £ Strirg pa舄1 . 产，蒙HM5Rgrd。；try EMap-cStriflo. ObjKt> nnfi rw« tosrtlaixStriino, SjKi>O：wp. put CAuthRepcrsi tory. fflDTtKiJt 摄匕 AuthReposi tory, flWTEtSL _ WiL iWJNS45L>map. pu-ttMjlfiRepi

14、Ki Lory u Ub£,_LD_KEY id);nap. purtCAiwtJiRjepcSii tony -3 q M);wp. pirt(Hile|W4i hsry, fifiJJHL&片 j .gel&cra vnfjjjwp u pM dhiepwi t617. SiffVDLWE KE, jid,跳tO&nainQX融*>2f不*售1*3| 即叮*Hi,*立*卢I/TRJirrirffTiTjI/pc if j dCr<5|x> gthgFfathCmap，?i jles.icLevtLFJMsr, 收,植修p抬勺蛇状爪 11M

15、de 驿”,配)catch CE»cwticp O tK. setvenfi edtfcl *);thr*Ow irw* lOExcepticr'PMErt? 1ve,.ficaticMn problE." ej;川1即0所旧也jaKRWfWrUj舅hwHHmpr由MM»PlrrCt：HySJSCflWKWioftigase在线坐席获取匿名用户登陆需要根据客户名分配一个在线坐席会话。tigaseroster插件就是用于返回好友列表，可以修改用来分配坐席列表o好文列以通道查询柱第 低处需及就fig贰*n列弗&国priM&it id wlk(f

16、trial Pocket 1卜的4打E1 旷Em MFHlm/Chetke'ilmhcs,EMi”ini.-paiai】鼻3手皿可布.R好”广。上2甫耳疗Stringstcr£Ha#口/Ifrli«Frtpwidndhathvwlth*urverBliculat迪hcharti#*uwZ/FfituTrlth£reiuLtQnd而artfurtherrOStfi/prtMjSLng./iNaneedtasendtheriaLerEatcrtotheclient.IftIMOM通山如后/111X、卜寸-4虾门.e."fifti1.grtBuddir

17、sItaVi(,叫.听J;if£C5±srcdHSi.Full)|IEtarcdHask-isEjieytlupOa(EH(ar<M3sicnBsettlings允stcnrfksh«Hwttr.jjfell.mHnh(Million力)IfC町*Ls(HaiWtoh)(rEltA*Tf*iKpoLkrt.aResrjlkjfSth”null.(中，_)；.rt«EZ/fctriew,HnArdngbtfiTitem.Liil-cLLanntjrt«u-nuLer.i/LtII.9atAulcrltiam-ficssitHi/?Scrat

18、!tfeu»rBsjWrxRndrgatsrFin)讦£rifean41.Hull>U(riljnfi.«i«vQ>.J>(ElmMQjeryE.La«ft(七收.">插件的调用就是在SessionManager中调用:料 final Elenert flen<P final QuB#cFcchet> remits) forroc Oja rife pDc.t : pmviKn .vqIues() WgpCMwH性 proc*w * ipECit ；AuthartzMLcn r«5uEl

19、.=. procKr. cdfHndleC»ock*t F csr*£tlDrJ：if (rfisblt Adthofijdtiw.EfCZcitf.l.FJtfSO)IEk.UwCLwtl/XF.!n*WKtiswifc;fit)(1-丁+*,|2rraflH!(4|9IMhCfcjoctnIMK4SWT.gfftflHOWVl4hOW),proc1rtm.GiIQfntaajucejNM)；1P#MinflThrMdfliwritortiif*ThriBas>rtmrster'Hineads.QVtCnr«sv：r.iO);if5-erI加入任第

20、队列中新萝”桂里近小舞|H'k=产(,4LL.gi曾.TMM41MI);if(p±.iDd(ntEnCprcceuiarppacket.canrwctLm7J.prtx.essedtyCprTK.e'-wr.tit*/koCqkdebtWJue啖XifiU-caletlMl.客户端获取好友列表variq=$iq(type：'get',id:'getmyroster')、c('query',xmlns:Strophe、NS、ROSTER)、tree();connection、send(iq);tigase消息转发流程用户在

21、发消息给客服时，如果客服不在线，需要分配给机器人客服，机器人客服就是以tigase客户端方式使用的，并且为了负载均衡会有多个机器人客服，所以还需要分配。分配这块功能需要修改tigasesessionmanage组件处理消息模块的一段代码。Tigase所有的消息都会经sessionmanager进行处，">butbrE.r|UF-a展L,贪SmOfMFUqFI-0nMeimgckiCEnalldTnhdli1汨8，AmhuIe17199PfMAUOfWfifWDVbKl*SeMKJlCkSMRM*乌S41lWCbMMTrWmi*嵋S4ni»nOp0fiw1S0Z闻5.l

22、»C3fir*EliiOinElaufimi4?WtilirGwf*EmlsfidB1W4“如廿IILCOMgM口NDOCites45«5中忖工LQH.TiblE叱嗯1906fu«-lmiia«+4i0fe4f1段”中!*P1u0f1fe1面Kr>aKRh_HBpOtfiiDO<Yt-H#iTteiml»whimwii1a10dc*wiii4lCDeGtionflisiircxnmcIkrCTiiKJtEDfniTiandHanOc1412fm1813ndelPactoeOMintitar1SJ4"WiPMgn*ThfwH

23、*WIM13*k-Hiarkbi&dBwkhsnh”tsU16理。packet.toSilnngSecureC),此处加我增加的代蚪，用户分配容蜃，1柏县F履P1(3Ckfrt TrCrtnHandler ,k ? t);,rrfirpCHitury,',''.tillpacket.prace«£fiy("Fi1ter-fowordri)：ifCloo-isloofiablt(Lewl.Fjflf5Q)(.logCLewl.fJW57."Packetpreorocessed:板,poc«et.toStringS?

24、ajre<»；ifCf'fsuUs.sueC)>0)fortocicjetp:results)I«,logCLflv«l,flWfSTj.Prrpnxessm%It:0J.pBicStrtngSecureO)addOutPockrtiiCptxppesult)*tigase的消息内部会转换为packet对象 分配客服机器人就是改变消息的接受者 这块是我自定义实现的例子；publicclassPacketTcansformUandler9/消息转战publicstaticvoidprocess|Puketpacke(>JifCpcc<

25、etxgetTypeC-FStanzflType.chat)，/酊0匿©服势擂接收消梅Stringf5«8*%上53日3电七.getPocketFrari().etBdreJID(5-etLocalportO;StringtoCmMu犷=packt?t.cjetPacketTaQ.getBareJIDQ.getLocolpar-tC);if(fromConipNcrie.equalst'kjosh'')ptry»/技变消息发送日糖者9/这里可以自定义分配相关功能DJIDdis10=JID»jidlnstanceC,Hzhangso

26、nlinux-wcSkH;hpacket.setStanzaTo(disID);2System.otrt.printin(hpacketdifpacter.*.*,J+potKet.toStriMO);catchCTigaseStringprepExceptiorie)H/TOGOAuto-generatededtehblocke<prirrtStCJCkTraceO;6)7i/±i*se麻弱幡发送消息ifffromConipName.equalstsessLondh)&&totoripWame.equals<Hsession"3)Packet类

27、中没有setStanzaTo方法需要修改加入ODD857：8588598608616public JID getStanzaTo() return stanzaTo;)862863864-public void setStanzaTo(JID jid) this.stanzaTo=jid;tigase离线消息存储tigase在用户不在线时，会把消息存储在数据库中，默认就是关系型数据库，这块我们就是需要存储到hbase等nosql数据库中的，这块功能需要修改下源码tigase已经写好的离线消息插件。此外tigase默认的离线消息存储就是有条数限制的，需要修改配置文件-sess-man/pluqi

28、ns-conf/amp/store-limit=1000tigase用户连接断开通知客服client与server连接断开，SessionManager会接收到断开消息，会话断开就是通过 SessionCloseProc插件实现。断开通知客服需要在连接断开时，发一条消息给客服JID通知25SAprivateclassSassionCloseProcextendsXMPPProcessor1559irrvlementsXMPPProcessorlfc25G&-rridekSi-1publicintconcurrertQueuesNoC>return4;256325642565Ove

29、rridepublicStringid。£5F7returnsessiandosProdd256SZ56925T&eOverride,：publicvoidprocessfPacketpacketjXRFPResourceConnectionsession»MonAuthUserRepositoryrepo,Queue<Packet>results,Map<String,Object>settings)throwsXMPPException-574if(Z0,isLoggabletLeveliFINEST)5j.logJogCLeweLFIN

30、FST,HExecutingconnectionclosefor：0",packet);257&)25772578StringuserJid>Ccmarid(*tFieldWilue(packetF'usqf*jid");25792580closeConnectionfsession,packet,getFranC),-Emzid,falser2581'582/TODO断开连摄处理a趟hm希部遵唳肥晟厘try(Sdtri呷-unG汕Sstm.flLHt.prinrtlntclosedJid*"klosedT;JIDjifliiftat

31、iL总-JID.JJLnii-wiSi:,"-7Eltfwi.rwELHViEntc*);BictJl4tributC('ryp«"p"dwt"l；产；qnvuagB-.HtA3rtrntutB("Dilnt",n.11ElawnEndy-yElftrentC+body*a+-h*_typeV,:XiW,VawtmtvAZV."rrteJtwteV*s-dwneL工皿丫：Y孰。STJusmesswlctHitt-luiLii,SmJ«1«vHnt.fld<tndy);T-3Fmug

32、c.adidOildrcn(cLaiList);."Fockrlp-R>ck«tJfiEtaracA(fniuqg*fpack#L.gELFn»(Jf2WS5二.遗.害fllJlEse蜡qnaT0方法Packet野不春春.要建加改为港硒|1c皿w口抑曲h萨但/卜.fletf-wO);5sLbfh.out.pFifitln<'tfi.spotdied*G;也*戟<ji);铺曲CemkE力2SU7W1I5308578588598国)861©862863864-Packet类中没有setStanzaTo方法需要修改加入publicJI

33、DgetStunzaToO(returnstanzaTo;publicvoidsetStanzaTo(JIDjid)this.stanzaTo=jid;tigase组件插件开发tigase组件插彳+开发，官方开发文档有详细介绍，可直接阅读tigase-DevelopmentGuide、pd，已上传上传到svn。云果以后需要自定义一些组件、插件实现自定义功能。tigase配置文件云果基于tigase源码开发功能时，需要增加一些自定义的配置，关于配置文件模块，tigase就是作为个组件开发的，所以我们仅需要简单修改一下配置文件模块。画均曰FPEit出】叼典iq*.cnFwE!rtEnlM-ii晋F

34、dUiG.#lyg4.>raF»WJ_Hrtfl4rHt也iqflwcni*,j'j所A>»*国CdHlKaiP<*Hf¥fft*rjH4sGLBpfwhxvm*.匚5gd口3>心阵1山d司rhML-peBXsLjtwii度向amda卜."1©出*曲伸ribump图中a.dtiRn* 鹿IqiBM.-dii-sn卧出MeMej* "严iq-W-Q声* 任 aligni.”a*由胡 内后咫1M /叱*制冰晔4匾强*.gE丽 %电HieI1”0r#tuiraj；tlgi9clSHtiAEIMoElE.t，&

35、gt;ObjKt>dtU-ttrrpcMrtiafltiD#fa(#lftonf1BhwiQqJ£|0-loflCLevs!.tcM/6b'Component下drfnults-IFBrw*ftijectDcorp明业抬!);5*1<M4P,Object*d*f*_*n«rin-1tM*0；惊呼ImmndifiKl.他、叩for-(wap,fcn£ry<StringBObjecUerlriSafs.enlr;eOif(!约甲<Mhn供Momm里想叫©»(口roo,网$(/【，.oriKtK).eniry.oetV

36、alutO);iWMllfied9true;/end&FifQJ/ndatfoeOitOodlHQ”(I啾Leel.Egi工1a"onp&if邮csrrftrYrti的：I1'.nObjectQ£cDflpidrprop13：Lorifl.gRx).putPrcpertte&(LiIdi+nrapjj砒thmwmLEExtptiOrt»«)loff.LogCLMl.NUM随."FrafcieriAltHswirigexnftgLirartLcxnprccrttesfararfKinent.:'#uwim.

37、en);)/«derfiF(vrahfiMl)preti.putCHeflftUtaF醛BMSMWHLLSW界肛WROP,f3r即一厘1尤口中,加tCHeptBiMMoctfliry.WWfILgffiLftEflCLfiWUlCLfWDFL睚工g_甲LjMrai；p1可：阳tCftjeqfXHltorfacBry1MAlfMhLjnpoivpl)iiarQPiPutXRapaiitiandFoctoryiSMWSLAiTXfiEAOLftVUliS-PRQFLNfViwth_rc»,ar«<s-hUpxwnt1ttrPreport展fi/m；ifqccnp

38、cmcnt-thiljsetup_in_prcqrEis-1fdim：tigasesslSSL(SecureSocketsLayer安全套接层)，及其继任者传输层安全(TransportLayerSecurity,TLS)就是为网络通信提供安全及数据完整性的一种安全协议。TLS与SSL在传输层对网络连接进行加密Tigase支持ssl通信功能，底层使用NIO+JSSE实现1、启用ssl修改init、properties,增加配置-bosh-ports=5280,5281bosh/connections/5281/socket=sslbosh/connections/5281/type=accep

39、t注:5280端口号用于正常通信，5281端口号用于ssl通信2、js连接tigasessl由原来的访问地址改为即可正常访问。注：由于https请求浏览器需要可信证书才允许访问，否则会拒绝访问，需要把访问的https地址设置为可信才能访问或者加入可信证书。导入pem文件至浏览器下面3会介绍。3、ssl证书tigase发布的包解压后，在certs/目录中包含了密钥与证书，其中后缀名位、pem就是ssl钥匙包含了公钥与私钥匙,tigase启动时会为每个domain生成一个domain、pem文件，如果不配置domain使用default、pem文件。pem文件也可以使用openssl生成，上线系统

40、建议自己生成。pem文件可以导入至浏览器证书中，这样浏览器才不会禁止您的https请求。证书如下所示：9 *»本培嗔目第世(j暴统垠证书苒武*汶”i JApplicartian Irlegnartian Ccrtif catkin 鼻证书20177270 0.3-16 03上 J, «m jpp4e.d.*poeid Jprd.525539fl*6BBe?l7B5l4Gi7BB«F&1.3&65?l3J!：!57374?A13e3d通事而月 Z2 日 14：30：35墀书m 唐3啊1号白13:44:141 J尹暂悼月Mnmimllrtux-iffl

41、：5k好立电ME*m Miew nfljsB星事二中啦*时与713t *8-此酒书密木甘过第三为叫il注:上线系统外网使用ssl一般采用第三方的收费的商用证书，客户端导入证书非常shan麻烦，浏览器内部会有一些CAROOT证书，一般包含了常用的商用证书。tigase负载均衡Tigase从5、2、0版开始，引入了负载均衡功能，可以把终端访问用户重定向到最适合的集群节点上。此负载均衡功能依赖于see-other-host的XMPP流错误消息(streamerrormessage)。此机制背后的基本原则就是如果用户当前正尝试连接的节点与返回消息的节点不就是集群中的同一个节点，那么用户将被重定向。此原则需要获得用户