Наконец, я смог реализовать приложение для чата с помощью CometD и более настраиваемых окон чата, открывающихся в браузере, который в точности похож на Facebook. Это работает практически во всех современных браузерах. Эта статья шаг за шагом объясняет, как реализовать приложение для чата с нуля, а также Как интегрировать приложение для чата в существующее базовое веб-приложение на Java. Помните, что ваше веб-приложение должно быть базовым на Java.
Вам нужно скачать cometD с их официального сайта. Он имеет все зависимости, необходимые для реализации приложения для чата, кроме библиотек java-скриптов. Я написал две библиотеки Javascript, одну для создания динамических окон чата, таких как Facebook, а другую для общего использования функций чата CometD. Если вы можете управлять этими вещами самостоятельно, вам не нужно использовать эти библиотеки Javascript. На самом деле, документация CometD предоставляет хорошие детали. Но я продолжаю обучение с использованием этих библиотек буксировки. В любом случае, я рекомендую сначала использовать эти библиотеки, а затем настраивать их по мере необходимости. Я надеюсь поделиться с вами примером приложения, и вы сможете развернуть его на своем локальном хосте и проверить, как оно работает.
1. Добавление необходимых файлов JAR.
Если вы используете maven для создания своего проекта, добавьте следующие зависимости в ваш файл pom.xml
|
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
<dependencies> <dependency> <groupId>org.cometd.java</groupId> <artifactId>bayeux-api</artifactId> <version>2.5.0</version> </dependency> <dependency> <groupId>org.cometd.java</groupId> <artifactId>cometd-java-server</artifactId> <version>2.5.0</version> </dependency> <dependency> <groupId>org.cometd.java</groupId> <artifactId>cometd-websocket-jetty</artifactId> <version>2.5.0</version> <exclusions> <exclusion> <groupId>org.cometd.java</groupId> <artifactId>cometd-java-client</artifactId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-simple</artifactId> <version>1.6.6</version> </dependency> <dependency> <groupId>org.cometd.java</groupId> <artifactId>cometd-java-annotations</artifactId> <version>2.5.0</version> </dependency></dependencies> |
Если вы не используете maven для создания своего проекта, просто скопируйте следующие файлы .jar в папку / WEB-INF / lib из вашего комплекта загрузки CometD. Эти файлы .jar можно найти в файле /cometd-demo/target/cometd-demo-2.5.0.war .
- Байе-апи-2.5.0.jar
- cometd-Java-аннотаций-2.5.0.jar
- cometd-ява-синфазного 2.5.0.jar
- cometd-ява-сервер-2.5.0.jar
- cometd-WebSocket-мол-2.5.0.jar
- javax.inject-1.jar
- Причал-продолжающий 7.6.7.v20120910.jar
- Причал-клиент-7.6.7.v20120910.jar
- Причал-ю-7.6.7.v20120910.jar
- Причал-JMX-7.6.7.v20120910.jar
- Причал-Util-7.6.7.v20120910.jar
- Причал-WebSocket-7.6.7.v20120910.jar
- jsr250-апи-1.0.jar
- SLF4J-апи-1.6.6.jar
- SLF4J-простой 1.6.6.jar
2. Добавление необходимых файлов Javascript.
Вам необходимо связать следующие файлы Javascript.
- cometd.js
- AckExtension.js
- ReloadExtension.js
- JQuery-1.8.2.js
- jquery.cookie.js
- jquery.cometd.js
- jquery.cometd-reload.js
- chat.window.js
- comet.chat.js
‘ Chat.window.js ‘ и ‘ comet.chat.js ‘ — мои собственные библиотеки Javascript, которые не поставляются с дистрибутивом CometD. Если вы полностью следуете этому руководству, вы должны также связать эти библиотеки. Прилагаемый пример приложения имеет эти две библиотеки Javascript.
3. Написание класса обслуживания чата.
|
001
002
003
004
005
006
007
008
009
010
011
012
013
014
015
016
017
018
019
020
021
022
023
024
025
026
027
028
029
030
031
032
033
034
035
036
037
038
039
040
041
042
043
044
045
046
047
048
049
050
051
052
053
054
055
056
057
058
059
060
061
062
063
064
065
066
067
068
069
070
071
072
073
074
075
076
077
078
079
080
081
082
083
084
085
086
087
088
089
090
091
092
093
094
095
096
097
098
099
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/** * @author Semika siriwardana * CometD chat service. */package com.semika.cometd;import java.util.HashMap;import java.util.Map;import java.util.Set;import java.util.concurrent.ConcurrentHashMap;import java.util.concurrent.ConcurrentMap;import javax.inject.Inject;import org.cometd.annotation.Configure;import org.cometd.annotation.Listener;import org.cometd.annotation.Service;import org.cometd.annotation.Session;import org.cometd.bayeux.client.ClientSessionChannel;import org.cometd.bayeux.server.BayeuxServer;import org.cometd.bayeux.server.ConfigurableServerChannel;import org.cometd.bayeux.server.ServerMessage;import org.cometd.bayeux.server.ServerSession;import org.cometd.server.authorizer.GrantAuthorizer;import org.cometd.server.filter.DataFilter;import org.cometd.server.filter.DataFilterMessageListener;import org.cometd.server.filter.JSONDataFilter;import org.cometd.server.filter.NoMarkupFilter;@Service('chat')public class ChatService { private final ConcurrentMap<String, Map<String, String>> _members = new ConcurrentHashMap<String, Map<String, String>>(); @Inject private BayeuxServer _bayeux; @Session private ServerSession _session; @Configure ({'/chat/**','/members/**'}) protected void configureChatStarStar(ConfigurableServerChannel channel) { DataFilterMessageListener noMarkup = new DataFilterMessageListener(new NoMarkupFilter(),new BadWordFilter()); channel.addListener(noMarkup); channel.addAuthorizer(GrantAuthorizer.GRANT_ALL); } @Configure ('/service/members') protected void configureMembers(ConfigurableServerChannel channel) { channel.addAuthorizer(GrantAuthorizer.GRANT_PUBLISH); channel.setPersistent(true); } @Listener('/service/members') public void handleMembership(ServerSession client, ServerMessage message) { Map<String, Object> data = message.getDataAsMap(); final String room = ((String)data.get('room')).substring('/chat/'.length()); Map<String, String> roomMembers = _members.get(room); if (roomMembers == null) { Map<String, String> new_room = new ConcurrentHashMap<String, String>(); roomMembers = _members.putIfAbsent(room, new_room); if (roomMembers == null) roomMembers = new_room; } final Map<String, String> members = roomMembers; String userName = (String)data.get('user'); members.put(userName, client.getId()); client.addListener(new ServerSession.RemoveListener() { public void removed(ServerSession session, boolean timeout) { members.values().remove(session.getId()); broadcastMembers(room, members.keySet()); } }); broadcastMembers(room, members.keySet()); } private void broadcastMembers(String room, Set<String> members) { // Broadcast the new members list ClientSessionChannel channel = _session.getLocalSession().getChannel('/members/'+room); channel.publish(members); } @Configure ('/service/privatechat') protected void configurePrivateChat(ConfigurableServerChannel channel) { DataFilterMessageListener noMarkup = new DataFilterMessageListener(new NoMarkupFilter(),new BadWordFilter()); channel.setPersistent(true); channel.addListener(noMarkup); channel.addAuthorizer(GrantAuthorizer.GRANT_PUBLISH); } @Listener('/service/privatechat') protected void privateChat(ServerSession client, ServerMessage message) { Map<String,Object> data = message.getDataAsMap(); String room = ((String)data.get('room')).substring('/chat/'.length()); Map<String, String> membersMap = _members.get(room); if (membersMap == null) { Map<String,String>new_room=new ConcurrentHashMap<String, String>(); membersMap=_members.putIfAbsent(room,new_room); if (membersMap==null) membersMap=new_room; } String peerName = (String)data.get('peer'); String peerId = membersMap.get(peerName); if (peerId != null) { ServerSession peer = _bayeux.getSession(peerId); if (peer != null) { Map<String, Object> chat = new HashMap<String, Object>(); String text = (String)data.get('chat'); chat.put('chat', text); chat.put('user', data.get('user')); chat.put('scope', 'private'); chat.put('peer', peerName); ServerMessage.Mutable forward = _bayeux.newMessage(); forward.setChannel('/chat/' + room); forward.setId(message.getId()); forward.setData(chat); if (text.lastIndexOf('lazy') > 0) { forward.setLazy(true); } if (peer != client) { peer.deliver(_session, forward); } client.deliver(_session, forward); } } } class BadWordFilter extends JSONDataFilter { @Override protected Object filterString(String string) { if (string.indexOf('dang') >= 0) { throw new DataFilter.Abort(); } return string; } }} |
4. Изменение файла web.xml.
Вы должны добавить следующий фильтр в ваш файл web.xml.
|
1
2
3
4
5
6
7
8
|
<filter> <filter-name>continuation</filter-name> <filter-class>org.eclipse.jetty.continuation.ContinuationFilter</filter-class></filter><filter-mapping> <filter-name>continuation</filter-name> <url-pattern>/cometd/*</url-pattern></filter-mapping> |
А также следующий сервлет.
|
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
<servlet> <servlet-name>cometd</servlet-name> <servlet-class>org.cometd.annotation.AnnotationCometdServlet</servlet-class> <init-param> <param-name>timeout</param-name> <param-value>20000</param-value> </init-param> <init-param> <param-name>interval</param-name> <param-value>0</param-value> </init-param> <init-param> <param-name>maxInterval</param-name> <param-value>10000</param-value> </init-param> <init-param> <param-name>maxLazyTimeout</param-name> <param-value>5000</param-value> </init-param> <init-param> <param-name>long-polling.multiSessionInterval</param-name> <param-value>2000</param-value> </init-param> <init-param> <param-name>logLevel</param-name> <param-value>0</param-value> </init-param> <init-param> <param-name>transports</param-name> <param-value>org.cometd.websocket.server.WebSocketTransport</param-value> </init-param> <init-param> <param-name>services</param-name> <param-value>com.semika.cometd.ChatService</param-value> </init-param> <load-on-startup>1</load-on-startup></servlet><servlet-mapping> <servlet-name>cometd</servlet-name> <url-pattern>/cometd/*</url-pattern></servlet-mapping> |
5. Реализация клиентских функций.
Я думаю, что этот раздел должен быть описательным. Если вы разрешаете своим пользователям общаться в чате с другими пользователями, вам нужно отобразить список онлайн-пользователей на вашей веб-странице, так же, как Facebook показывает онлайн-пользователей внутри правой боковой панели. Для этого вы можете разместить простой тег <span> или <div> на своей странице. Я сделал это следующим образом.
|
1
|
<div id='members'></div> |
Все онлайн-пользователи будут отображаться в указанном выше контейнере. Как только вы нажмете на определенное имя пользователя, откроется новое окно чата, похожее на Facebook. Для каждой пары пользователей откроется новое окно чата. Чтобы получить такое поведение, вы должны использовать chat.window.js, о котором я упоминал ранее. Общение между определенной парой пользователей будет продолжаться через специальное окно чата.
Сразу после того, как пользователь входит в ваше веб-приложение обычным способом, мы должны подписать этого пользователя на каналы чата. Вы можете сделать это следующим образом.
|
1
2
3
|
$(document).ready(function(){ $.cometChat.onLoad({memberListContainerID:'members'});}); |
Обратите внимание, что я передал ‘id’ контейнера списка пользователей в сети в качестве параметра конфигурации. Затем пользователь должен присоединиться к каналу следующим образом. Вы можете вызвать метод ниже с именем пользователя.
|
1
2
3
|
function join(userName){ $.cometChat.join(userName);} |
Поскольку для каждого чата существует отдельное окно чата, как и в Facebook, мы должны поддерживать глобальный массив Javascript для хранения созданных объектов окна чата. Вам нужно разместить следующий код Javascript внутри вашей страницы.
|
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
function getChatWindowByUserPair(loginUserName, peerUserName) { var chatWindow; for(var i = 0; i < chatWindowArray.length; i++) { var windowInfo = chatWindowArray[i]; if (windowInfo.loginUserName == loginUserName && windowInfo.peerUserName == peerUserName) { chatWindow = windowInfo.windowObj; } } return chatWindow;} function createWindow(loginUserName, peerUserName) { var chatWindow = getChatWindowByUserPair(loginUserName, peerUserName); if (chatWindow == null) { //Not chat window created before for this user pair. chatWindow = new ChatWindow(); //Create new chat window. chatWindow.initWindow({ loginUserName:loginUserName, peerUserName:peerUserName, windowArray:chatWindowArray}); //collect all chat windows opended so far. var chatWindowInfo = { peerUserName:peerUserName, loginUserName:loginUserName, windowObj:chatWindow }; chatWindowArray.push(chatWindowInfo); } chatWindow.show(); return chatWindow;} |
Как я упоминал выше, объявите следующую глобальную переменную Javascript.
|
1
2
3
4
|
var chatWindowArray = []; var config = { contextPath: '${pageContext.request.contextPath}'}; |
Поскольку я использую страницу JSP, мне нужно получить путь к контексту через переменную ‘ pageContext ‘. Если вы используете страницу HTML, управляйте ею самостоятельно, чтобы объявить глобальную переменную Javascript ‘config’. Теперь вы почти достигли последней части урока.
5. Как работает пример приложения?
Вы можете скачать файл comet.war и развернуть его на своем сервере. Направьте браузер на следующий URL.
HTTP: // локальный: 8080 / комета
Это приведет вас на страницу с текстовым полем и кнопкой «Присоединиться». Введите желаемое имя пользователя и нажмите кнопку «Присоединиться». Затем вы будете перенаправлены на другую страницу со списком онлайн-пользователей. Ваше имя выделено красным цветом. Чтобы пообщаться в чате на вашем локальном компьютере, вы можете открыть другой браузер (IE и FF) и присоединиться к каналу чата. Одноранговый пользователь отображается синим цветом в онлайн-списке пользователей. Как только вы нажмете на равноправного пользователя, он откроет новое окно чата, чтобы вы могли общаться с ним. Эта функция очень похожа на чат в Facebook.
Я протестировал это приложение для чата в IE, FF и Crome и работает отлично. Если вам нужна помощь в интеграции этого с вашим базовым веб-приложением на Java, просто отправьте мне письмо.
Справка: Facebook похожий чат для вашего веб-приложения Java. от нашего партнера JCG Семика локу калуге в блоге Code Box .