Skip to content

laozhaoJava/mpush

BranchesTags

Repository files navigation

详细教程

源码

ps:由于源码分别在github和码云有两份，最新的代码以github为主

服务调用关系

源码测试

  1. git clone https://github.com/mpusher/mpush.git
  2. 导入到eclipse或Intellij IDEA
  3. 打开mpush-test模块，所有的测试代码都在该模块下
  4. 修改配置文件src/test/resource/application.conf文件修改方式参照 服务部署第6点
  5. 运行com.mpush.test.sever.ServerTestMain.java启动长链接服务
  6. 运行com.mpush.test.client.ConnClientTestMain.java 模拟一个客户端
  7. 运行com.mpush.test.push.PushClientTestMain 模拟给用户下发消息
  8. 可以在控制台观察日志看服务是否正常运行，消息是否下发成功

服务部署

说明：mpush 服务只依赖于zookeeper和redis，当然还有JDK>=1.8

  1. 安装jdk 1.8 以上版本并设置%JAVA_HOME％

  2. 安装zookeeper (安装配置步骤略)

  3. 安装Redis (安装配置步骤略)

  4. 下载mpush server 最新的正式包https://github.com/mpusher/mpush/releases

  5. 解压下载的tar包tar -zvxf mpush-release-0.0.2.tar.gz到 mpush 目录, 结构如下

    drwxrwxr-x 2 shinemo shinemo 4096 Aug 20 09:30 bin —> 启动脚本 drwxrwxr-x 2 shinemo shinemo 4096 Aug 20 09:52 conf —> 配置文件 drwxrwxr-x 2 shinemo shinemo 4096 Aug 20 09:29 lib —> 核心类库 -rw-rw-r-- 1 shinemo shinemo 11357 May 31 11:07 LICENSE drwxrwxr-x 2 shinemo shinemo 4096 Aug 20 09:32 logs —> 日志目录 -rw-rw-r-- 1 shinemo shinemo 21 May 31 11:07 README.md drwxrwxr-x 2 shinemo shinemo 4096 Aug 20 09:52 tmp

  6. 修改 conf 目录下的 vi mpush.conf文件, mpush.conf里的配置项会覆盖同目录下的reference.conf文件

     #主要修改以下配置mp.net.connect-server-port=3000//长链接服务对外端口, 公网端口mp.zk.server-address="127.0.0.1:2181"//zk 机器的地址mp.redis={//redis 相关配置nodes:["127.0.0.1:6379"] //格式是ip:portcluster-model:single//single, cluster } //还有用于安全加密的RSA mp.security.private-key 和 mp.security.public-key 等...

    如果要修改其他配置请参照reference.conf文件

  7. 给bin目录下的脚本增加执行权限chmod u+x *.sh

  8. 执行./mp.sh start 启动服务, 查看帮助./mp.sh 目前支持的命令：

    Usage: ./mp.sh{start|start-foreground|stop|restart|status|upgrade|print-cmd}

    set-env.sh 用于增加和修改jvm启动参数，比如堆内存、开启远程调试端口、开启jmx等

  9. cd logs目录，cat mpush.out查看服务是否启动成功

  10. 集成部署，比如集成到现有web工程一起部署到tomcat,可以添加如下依赖

<dependency> <groupId>com.github.mpusher</groupId> <artifactId>mpush-boot</artifactId> <version>0.0.2</version> </dependency>

启动入口com.mpush.bootstrap.ServerLauncher.java

配置文件详解

################################################################################################################## # # NOTICE： # # 系统配置文件，所有列出的项是系统所支持全部配置项 # 如果要覆盖某项的值可以添加到mpush.conf中。 # # 配置文件格式采用HOCON格式。解析库由https://github.com/typesafehub/config提供。 # 具体可参照说明文档，比如含有特殊字符的字符串必须用双引号包起来。 # ################################################################################################################## mp{#基础配置home=${user.dir} //程序工作目录 #日志配置log-level=warnlog-dir=${mp.home}/logslog-conf-path=${mp.home}/conf/logback.xml #核心配置core{max-packet-size=10k//系统允许传输的最大包的大小compress-threshold=10k//数据包启用压缩的临界值，超过该值后对数据进行压缩min-heartbeat=3m//最小心跳间隔max-heartbeat=3m//最大心跳间隔max-hb-timeout-times=2//允许的心跳连续超时的最大次数session-expired-time=1d//用于快速重连的session 过期时间默认1天epoll-provider=netty//nio:jdk自带，netty:由netty实现 } #安全配置security{#rsa私钥、公钥key长度为1024;可以使用脚本bin/rsa.sh生成, @seecom.mpush.tools.crypto.RSAUtils#mainprivate-key="MIIBNgIBADANBgkqhkiG9w0BAQEFAASCASAwggEcAgEAAoGBAKCE8JYKhsbydMPbiO7BJVq1pbuJWJHFxOR7L8Hv3ZVkSG4eNC8DdwAmDHYu/wadfw0ihKFm2gKDcLHp5yz5UQ8PZ8FyDYvgkrvGV0ak4nc40QDJWws621dm01e/INlGKOIStAAsxOityCLv0zm5Vf3+My/YaBvZcB5mGUsPbx8fAgEAAoGAAy0+WanRqwRHXUzt89OsupPXuNNqBlCEqgTqGAt4Nimq6Ur9u2R1KXKXUotxjp71Ubw6JbuUWvJg+5Rmd9RjT0HOUEQF3rvzEepKtaraPhV5ejEIrB+nJWNfGye4yzLdfEXJBGUQzrG+wNe13izfRNXI4dN/6Q5npzqaqv0E1CkCAQACAQACAQACAQACAQA="public-key="MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCghPCWCobG8nTD24juwSVataW7iViRxcTkey/B792VZEhuHjQvA3cAJgx2Lv8GnX8NIoShZtoCg3Cx6ecs+VEPD2fBcg2L4JK7xldGpOJ3ONEAyVsLOttXZtNXvyDZRijiErQALMTorcgi79M5uVX9/jMv2Ggb2XAeZhlLD28fHwIDAQAB"aes-key-length=16//AES key 长度 } #网络配置net{local-ip=""//本地ip, 默认取第一个网卡的本地IPpublic-ip=""//外网ip, 默认取第一个网卡的外网IPconnect-server-bind-ip=""//connSrv 绑定的本地ip (默认anyLocalAddress 0.0.0.0 or ::0)connect-server-register-ip=${mp.net.public-ip} //公网ip, 注册到zk中的ip, 默认是public-ipconnect-server-port=3000//长链接服务对外端口, 公网端口connect-server-register-attr{//注册到zk里的额外属性，比如配置权重，可在alloc里排序weight:1 } gateway-server-bind-ip=""//gatewaySrv 绑定的本地ip (默认anyLocalAddress 0.0.0.0 or ::0)gateway-server-register-ip=${mp.net.local-ip} //本地ip, 注册到zk中的ip, 默认是local-ipgateway-server-port=3001//网关服务端口, 内部端口gateway-server-net=tcp//网关服务使用的网络类型tcp/udp/sctp/udtgateway-client-port=4000//UDP 客户端端口gateway-server-multicast="239.239.239.88"//239.0.0.0～239.255.255.255为本地管理组播地址，仅在特定的本地范围内有效gateway-client-multicast="239.239.239.99"//239.0.0.0～239.255.255.255为本地管理组播地址，仅在特定的本地范围内有效gateway-client-num=1//网关客户端连接数admin-server-port=3002//控制台服务端口, 内部端口ws-server-port=0//websocket对外端口, 公网端口, 0表示禁用websocketws-path="/"//websocket pathpublic-host-mapping{//本机局域网IP和公网IP的映射关系, 该配置后续会被废弃//"10.0.10.156":"111.1.32.137"//"10.0.10.166":"111.1.33.138" } snd_buf{//tcp/udp 发送缓冲区大小connect-server=32kgateway-server=0gateway-client=0//0表示使用操作系统默认值 } rcv_buf{//tcp/udp 接收缓冲区大小connect-server=32kgateway-server=0gateway-client=0//0表示使用操作系统默认值 } write-buffer-water-mark{//netty 写保护connect-server-low=32kconnect-server-high=64kgateway-server-low=10mgateway-server-high=20m } traffic-shaping{//流量整形配置gateway-client{enabled:falsecheck-interval:100mswrite-global-limit:30kread-global-limit:0write-channel-limit:3kread-channel-limit:0 } gateway-server{enabled:falsecheck-interval:100mswrite-global-limit:0read-global-limit:30kwrite-channel-limit:0read-channel-limit:3k } connect-server{enabled:falsecheck-interval:100mswrite-global-limit:0read-global-limit:100kwrite-channel-limit:3kread-channel-limit:3k } } } #Zookeeper配置zk{server-address="127.0.0.1:2181"//多台机器使用","分隔如："10.0.10.44:2181,10.0.10.49:2181" @see org.apache.zookeeper.ZooKeeper#ZooKeeper()namespace=mpushdigest=mpush//zkCli.sh acl 命令 addauth digest mpushwatch-path=/ retry{#initialamountoftimetowaitbetweenretriesbaseSleepTimeMs=3s #maxnumberoftimestoretrymaxRetries=3 #maxtimeinmstosleeponeachretrymaxSleepMs=5s } connectionTimeoutMs=5ssessionTimeoutMs=5s } #Redis集群配置redis{cluster-model=single//single,cluster,sentinelsentinel-master:"" nodes:[] s//["127.0.0.1:6379"]格式ip:portpassword="" //your passwordconfig{maxTotal:8, maxIdle:4, minIdle:1, lifo:true, fairness:false, maxWaitMillis:5000, minEvictableIdleTimeMillis:300000, softMinEvictableIdleTimeMillis:1800000, numTestsPerEvictionRun:3, testOnCreate:false, testOnBorrow:false, testOnReturn:false, testWhileIdle:false, timeBetweenEvictionRunsMillis:60000, blockWhenExhausted:true, jmxEnabled:false, jmxNamePrefix:pool, jmxNameBase:pool } } #HTTP代理配置http{proxy-enabled=false//启用Http代理max-conn-per-host=5//每个域名的最大链接数, 建议web服务nginx超时时间设长一点, 以便保持长链接default-read-timeout=10s//请求超时时间max-content-length=5m//response body 最大大小dns-mapping{//域名映射外网地址转内部IP, 域名部分不包含端口号//"mpush.com":["127.0.0.1:8080", "127.0.0.1:8081"] } } #线程池配置thread{pool{conn-work:0//接入服务线程池大小，0表示线程数根据cpu核数动态调整(2*cpu)gateway-server-work:0//网关服务线程池大小，0表示线程数根据cpu核数动态调整(2*cpu)http-work:0//http proxy netty client work pool size，0表示线程数根据cpu核数动态调整(2*cpu)ack-timer:1//处理ACK消息超时push-task:0//消息推送中心，推送任务线程池大小, 如果为0表示使用Gateway Server的work线程池，tcp下推荐0gateway-client-work:0//网关客户端线程池大小，0表示线程数根据cpu核数动态调整(2*cpu)，该线程池在客户端运行push-client:2//消息推送回调处理，该线程池在客户端运行event-bus{//用户处理内部事件分发min:1max:16queue-size:10000//大量的online，offline } mq{//用户上下线消息, 踢人等min:1max:4queue-size:10000 } } } #推送消息流控push{flow-control{//qps = limit/(duration)global:{//针对非广播推送的流控，全局有效limit:5000//qps = 5000max:0//UN limitduration:1s//1s } broadcast:{//针对广播消息的流控，单次任务有效limit:3000//qps = 3000max:100000//10wduration:1s//1s } } } #系统监控配置monitor{dump-dir=${mp.home}/tmpdump-stack=false//是否定时dump堆栈dump-period=1m//多久监控一次print-log=true//是否打印监控日志profile-enabled=false//开启性能监控profile-slowly-duration=10ms//耗时超过10ms打印日志 } #SPI扩展配置spi{thread-pool-factory:"com.mpush.tools.thread.pool.DefaultThreadPoolFactory"dns-mapping-manager:"com.mpush.common.net.HttpProxyDnsMappingManager" } }
  1. 未完待续...

About

MPush开源实时消息推送系统

mpusher.github.io

Resources

Readme

License

Apache-2.0 license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

9tags

Packages

No packages published

Languages

  • Java97.5%
  • Shell1.4%
  • Other1.1%