Memcached 与 Wowza 项目的集成

Posted 2020-09-11 jzdwajue

        集群是 Wowza 部署的必修课，集群环境下的 Wowza 插件所依赖到的缓存採用 Memcached 作为解决方式是个不错的选择。本文简介怎样在 Wowza 插件开发项目中增加 Memcached 支持，关于 Memcached 数据原子性、Memcached 的集群以及 java 进程内缓存临时没有涉及。本文演示样例代码用的是 spymemcached 2.8.4。
        本文在博客《使用 spring 集成 dbcp 数据库连接池到 Wowza 插件》演示样例项目的基础上对 Memcached 进行集成。该博客代码下载地址：http://download.csdn.net/detail/defonds/7098633。
        1. 导入上篇博客演示样例代码
        将《使用 spring 集成 dbcp 数据库连接池到 Wowza 插件》的演示样例代码导入 Eclipse。关于 Eclipse 的 Wowza 插件的安装、Wowza 项目的新建及其调试、spring 的集成请參阅曾经博客。成功导入后 Eclipse 下的视图例如以下：

        2. Memcached 公共接口实现
        新建 CacheService 接口代码例如以下：

package com.defonds.wms.module.cache.service;

public interface CacheService {
	
	void init(); // while server start up, do something
	
	void destory(); // while server shut down, do something
	
	void put(String key, Object object); // set new value to cache
	
	void remove(String key); // remove from cache
	
	Object get(String key); // get current value from cache
	
	boolean exist(String key); // check whether the key already exist in cache or not
}

        CacheService 的实现类 CacheServiceImpl 代码：

package com.defonds.wms.module.cache.service;

import java.io.IOException;
import java.net.InetSocketAddress;

import net.spy.memcached.MemcachedClient;

import com.wowza.wms.logging.WMSLogger;
import com.wowza.wms.logging.WMSLoggerFactory;

public class CacheServiceImpl implements CacheService {
	private static final WMSLogger logger = WMSLoggerFactory.getInstance().getLoggerObj(CacheServiceImpl.class.getName());
	private MemcachedClient memcachedClient = null;
	private String memcachedIpAddress; // memcached server ip address
	private Integer memcachedServerPort; // memcached server port
	private Integer memcachedObjectExpiration; // objects set to memcached will be expired after 86400 (86400 = 60 * 60 * 24) seconds
	

	@Override
	public void init() {
		logger.debug("CacheServiceImpl--init--debug--memcachedIpAddress=" + this.memcachedIpAddress 
				+ ";memcachedServerPort=" + this.memcachedServerPort
				+ ";memcachedObjectExpiration=" + this.memcachedObjectExpiration);
		try {
			logger.debug("CacheServiceImpl--init--debug--MemcachedClient will init now");
			this.memcachedClient = new MemcachedClient(new InetSocketAddress(this.memcachedIpAddress, this.memcachedServerPort));
		} catch (IOException e) {
			logger.error(e.getMessage(), e);
		}
	}

	@Override
	public void destory() {
		this.memcachedClient.shutdown();

	}

	@Override
	public void put(String key, Object object) {
		try {
			this.memcachedClient.set(key, this.memcachedObjectExpiration, object);
		} catch (Exception e) {
			logger.error("CacheServiceImpl--put-- insert object into memcached failed!");
		}
	}

	@Override
	public void remove(String key) {
		try {
			this.memcachedClient.delete(key);
		} catch (Exception e) {
			logger.error("CacheServiceImpl--remove-- delete object from memcached failed!");
		}
	}

	@Override
	public Object get(String key) {
		Object object = null;
		try {
			object = this.memcachedClient.get(key);
		} catch (Exception e) {
			logger.error("CacheServiceImpl--get-- select object from memcached failed!");
		}
		return object;
	}

	@Override
	public boolean exist(String key) {
		Object object = null;
		try {
			object = this.memcachedClient.get(key);
		} catch (Exception e) {
			logger.error("CacheServiceImpl--exist-- select object from memcached failed!");
		}
		if (object == null) {
			return false;
		} else {
			return true;
		}
	}

	public void setMemcachedIpAddress(String memcachedIpAddress) {
		this.memcachedIpAddress = memcachedIpAddress;
	}

	public void setMemcachedServerPort(Integer memcachedServerPort) {
		this.memcachedServerPort = memcachedServerPort;
	}

	public void setMemcachedObjectExpiration(Integer memcachedObjectExpiration) {
		this.memcachedObjectExpiration = memcachedObjectExpiration;
	}

}

        3. 增加 spymemcached 支持
        将 spymemcached-2.8.4.jar 增加到 defonds-server-module 的编译环境和执行环境(执行环境就是 %wowza%/lib)。
        4. 配置 Memcached
        就是 Memcached 服务器地址、端口号以及数据保鲜期的配置。config.properties 中增加下面：

memcached.ip.address=172.21.0.117
memcached.server.port=12111
#objects set to memcached will be expired after 86400 (86400 = 60 * 60 * 24) seconds
memcached.object.expiration=86400

        5. 使用 spring 对 CacheService 进行管理
        我们把 CacheService 对象的生命周期全权交给 spring 进行管理。spring-context.xml 中的 beans 标签下增加下面配置：

	<!-- cache related -->
	<bean id="cacheService" class="com.defonds.wms.module.cache.service.CacheServiceImpl" init-method="init">
		<property name="memcachedIpAddress" value="${memcached.ip.address}"></property>
		<property name="memcachedServerPort" value="${memcached.server.port}"></property>
		<property name="memcachedObjectExpiration" value="${memcached.object.expiration}"></property>
	</bean>	

        6. 部署并调试
        使用文本编辑器打开 Wowza 安装文件夹下的 conf 文件夹中的 Server.xml，在 ServerListeners 标签下增加下面内容：

			<ServerListener> 
				<BaseClass>com.defonds.wms.module.server.DefondsWowzaServerListener</BaseClass> 
			</ServerListener>

        在不论什么插件类中增加例如以下代码：

		ApplicationContext appCtx = ApplicationContextUtils.getApplicationContext();  
		// test cache
		String testFlag = "now" + System.currentTimeMillis();
		CacheService cacheService = (CacheService) appCtx.getBean("cacheService");
		if (!cacheService.exist("somekey")) {
			cacheService.put("somekey", testFlag);
		} 
		logger.debug("DefondsWowzaServerListener-onServerInit-memcached-somekey=" + cacheService.get("somekey"));

        执行该插件类后打印接过例如以下：
DEBUG server comment - DefondsWowzaServerListener-onServerInit-memcached-somekey=now1398324763217
        測试成功。

        注意：关于 Wowza 插件的 log
        Wowza 的 logging 实现採用的是 Apache 的 log4j logging 工具。log4j 的配置文件在 %wowza%/conf/log4j.properties，默认配置例如以下：

log4j.rootCategory=INFO, stdout, serverAccess, serverError

        假设我们想在开发时对插件项目中的一些自己定义类中改动日志级别，仅仅能在 %wowza%/conf/log4j.properties 进行改动，在其它地方另加自己定义 log4j.properties Wowza 是不认的。比方我们要将 CacheServiceImpl 的日志级别改动为 DEBUG。那么应该在 %wowza%/conf/log4j.properties 文件末尾增加一行：

log4j.logger.com.defonds.wms.module.cache.service=DEBUG

        然后重新启动 Wowza 就可以。
        另外，CacheServiceImpl 里获取 WMSLogger 一定要用这样的写法：

        WMSLogger logger = WMSLoggerFactory.getInstance().getLoggerObj(CacheServiceImpl.class.getName());

        其它的诸如 WMSLoggerFactory.getLogger(CacheServiceImpl.class) 或者 WMSLoggerFactory.getLogger(null) 尽管也能输出日志。但 log4j.logger.com.defonds.wms.module.cache.service=DEBUG 对其日志级别的改动无效。
        后记
        本资源源代码已上传 csdn 资源。有兴趣的朋友能够去下载一下，链接地址：http://download.csdn.net/detail/defonds/7245973。