SCFF

Simple C++ FastCgi Framework 简单便捷的c++ FastCgi 框架，快速生成代码框架，关注业务CGI快速开发。对接各种提供fastcgi协议的服务器。 更多简介

SCFF部署步骤

SCFF编写CGI指南

====

SCFF简介 一 SCFF是基于FastCgi协议的C++ Web框架

二 SCFF提供了代码框架AutoGen

通过echo.h文件autogen出代码框架，lib提供接口路由及参数封装功能，只需要在 Src目录实现业务功能接口即可。

三 SCFF提供执行框架及工具

把编译好的fcgi放到cgi目录，并且修改配置文件及bin目录的service_manage.sh和 protect.sh 。 通过service_manage.sh进行管理进程启动和关闭。 通过protect来守护fcgi进程正常服务及告警。

四 SCFF提供usocket方式提供FastCgi服务，可通过Nginx路由多个服务。 location ~/cgi/(\w+)/ { fastcgi_pass unix:/dev/shm/$1.fcgi.sock; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; include fastcgi_params; }

五 SCFF高性能FastCgi服务。 性能压测：(4核、8GMEM)单机HelloWord达到4.3k/s，（空转nginx是4.6k/s）。贴近nginx的处理能力。

SCFF部署步骤

一 安装Boost库（已安装，请忽略）

下载boost库：http://www.boost.org/

编译boost库：

1. 解压源码包
2. ./bootstrap.sh --prefix=/home/johnsonzhu/local/boost/
3. ./bjam install 或者 ./b2

二 安装fastcgi++

1. ./configure --prefix=/home/johnsonzhu/local/fastcgipp --with-boost=/home/johnsonzhu/local/boost/
2. make;make install;

三 安装ctemplate.0.88

1. ./configure --prefix=/home/johnsonzhu/local/ctemplate.0.88
2. make install

四 设置环境变量

export HOME=/home/johnsonzhu/ export FCGI_INC_EXPORT_PATH=$HOME/local/fastcgipp/include/ export BOOST_INC_EXPORT_PATH=$HOME/local/boost/include/ export CTEMPLATE_INC_EXPORT_PATH=$HOME/local/ctemplate.0.88/include/ export WEBFRAMEWORK_INC_EXPORT_PATH=$HOME/local/webframework/include/

export FCGI_LIB_EXPORT_PATH=$HOME/local/fastcgipp/lib/ export BOOST_LIB_EXPORT_PATH=$HOME/local/boost/lib/ export CTEMPLATE_LIB_EXPORT_PATH=$HOME/local/ctemplate.0.88/lib/ export WEBFRAMEWORK_LIB_EXPORT_PATH=$HOME/local/webframework/lib/

五 安装webframework

1. make
2. make install （注意设置好环境变量，根据环境变量安装webframework）

六 编译Echo例子

1. cd example/echo
2. make

七 部署Echo例子

1. cd webapps/echo/bin
2. 启动 ./service_manager.sh start
3. 修改Nginx配置，如 location ~/cgi/(\w+)/ { fastcgi_pass unix:/dev/shm/$1.fcgi.sock; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; include fastcgi_params; }
4. 访问fcgi，url如：domain.com/cgi/echo/getloc?gettest=abc

SCFF 编写指南

1. 使用AutoGen生成代码框架

---

你提供一个业务C++头文件和一个目的目录，AutoGen它就会根据这个头文件在目的目录中生成框架代码。

cd auto_gen; ./auto_gen.sh

USAGE : ./auto_gen.sh <head_filename> <dest_dir>

EXAMPLE: ./auto_gen.sh aoitem_msg.h ~/my_test

但是，AutoGen还没有智能到可以分析任意的C++头文件，所以这个业务头文件需要遵循一定的格式。

文件testservice.h

#ifndef FCGI_DEMO_ECHO_H 
#define FCGI_DEMO_ECHO_H 

#include <string>
#include <stdint.h>
#include "help_macros4web.h"
#include "web_view.h"
#include "action_params.h"
#include "web_svc_cntl.h"

namespace fcgi
{
	namespace demo
	{
		namespace echo
		{
			SERVICE class CEcho
			{
				public:
					CEcho();
					~CEcho();
					int Initialize(const char* pszVhostRootPath, const char* pszServiceConfigFile);
					void Reset();

				public:
					EXPORT uint32_t GetLoc(
							const web_solution::web_framework::CActionParams& rParams,
							web_solution::web_framework::CWebViewData& rData,
							web_solution::web_framework::CWebSvcCntl& rCntl
							);
				public:
					int RenderGetLoc( std::string& sOutputBuffer,
							web_solution::web_framework::CWebViewData& rData,
							web_solution::web_framework::CWebSvcCntl& rCntl
							);
				private:
					int VerifyGetLoc(
							const web_solution::web_framework::CActionParams& rParams);
			};
		}
	}
}

#endif /* FCGI_DEMO_ECHO_H*/

SERVICE宏用于标识一个class为业务Service（CTestService），它的某些方法需要暴露出来供前端调用；

EXPORT宏用于标识Service中的这个方法需要暴露给前端调用，AutoGen4Web会收集这些方法，并在粘接剂代码中生成路由分发代码。

上述代码中，我们指定了一个名为Echo的Action，伴随这个Action还需要键入一个EchoRender和VerifyEchoInput方法，分别用于渲染输出页面和校验用户输入。

完成头文件后保存到~/echo.h，然后执行下面步骤来生成框架：

1）cd auto_gen

2）sh auto_gen.sh ~/ echo.h ~/webapps/生成框架，webapps下会生成一个echo目录：

lib——是自动生成的粘接剂代码；

src——下面是用户自己的代码，用户需要把自己编写的h和cpp等放入其中；

cgi——里面的Makefile可构建出FCGI；

websvc——暂时不适用（后续支持so加载）。

3）cd src

4）cp ~/echo.h . 复制业务头文件到src目录下；

接下来开始编写业务逻辑代码，文件echo.cpp。

#include <string>
#include <sstream>
#include <iostream>
#include <map>
#include <vector>

#include "echo.h"

using namespace std;
using namespace web_solution::web_framework;
using namespace fcgi::demo::echo;

int CEcho::Initialize(const char* pszVhostRootPath, const char* pszServiceConfigFile)
{
	int iRet = 0;

	return iRet;
}

uint32_t CEcho::GetLoc(
							const web_solution::web_framework::CActionParams& rParams,
							web_solution::web_framework::CWebViewData& rData,
							web_solution::web_framework::CWebSvcCntl& rCntl
							)
{
	uint32_t dwRet = 0;
	string areaData = "Hello Echo Demo!";

	string gettest = "";
	if (rParams.GetVal("gettest", gettest) != 0)
	{
		gettest = "";
	}

	string method = "";
	if (rParams.GetVal("HttpMethod", method) != 0)
	{
		method = "";
	}
	
	string prid = "";
	if (rParams.GetCookieVal("prid", prid) != 0)
	{
		prid = "";
	}

	areaData += "<br />gettest get:" + gettest;
	areaData += "<br />prid cookie:" + prid;
	areaData += "<br />method:" + method;
	rData.SetUserData("content", areaData);

	cout << "test cout"<<"<br />";
	// test cookie
	rData.UpdateCookieVal("echo_test_cookie", "johnsonzhu", "Sat, 08 Nov 2014 09:26:30 GMT", "yixun.com");
	rData.UpdateCookieVal("echo_test_cookie2", "johnsonzhu2", "Sat, 08 Nov 2014 09:26:30 GMT", "yixun.com");
	rData.DelCookieVal("echo_test_cookie2");

	// test 302
	//string redirectUrl = "http://u.yixun.com/abc?noRedirect=1";
	//rCntl.SetLocation(redirectUrl);
	//rCntl.SetResult(302);
	return dwRet;
}

int CEcho::RenderGetLoc( std::string& sOutputBuffer,
							web_solution::web_framework::CWebViewData& rData,
							web_solution::web_framework::CWebSvcCntl& rCntl
							)
{
	uint32_t dwRet = 0;

	//设置max-age,暂时设置10秒
	uint32_t maxAge = 10;
	rCntl.SetBrowserCacheExpireTime(maxAge);
	rCntl.SetMimeEncoding("abc");
	rCntl.SetMimeType("text/html; charset=utf-8");

	string content = "";
	string errMsg = "";
	rData.GetUserData("errMsg", errMsg);
	if (!errMsg.empty())
	{
		sOutputBuffer = errMsg;
	}
	else
	{
		rData.GetUserData("content", content);
		sOutputBuffer = content;
	}
	return dwRet;
}

int CEcho::VerifyGetLoc(
							const web_solution::web_framework::CActionParams& rParams)
{
	uint32_t dwRet = 0;
	return dwRet;
}

CEcho::CEcho()
{
}

CEcho::~CEcho()
{
}

void CEcho::Reset(){}

2. 生成CGI

---

在cgi目录执行make，生成可执行的echo.fcgi。

3. 部署CGI

---

3.1. 在webapps目录拷贝新目录echo

3.2. 在echo目录下的cgi目录部署刚才编译好的echo.fcgi

3.3. 在echo/bin目录下修改配置文件

3.3.1. service_manager.sh修改ServerName和进程数PROC_NUM

3.3.2. Protect.sh修改服务名和进程数

3.4. 启动服务 在bin目录执行./service_manager.sh start

另外可以查看cgi进程情况./service_manager.sh show

3.5. Nginx配置修改

location ~/cgi/(\w+)/ { fastcgi_pass unix:/dev/shm/$1.fcgi.sock; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; include fastcgi_params; }

3.6. 访问服务

访问fcgi，url如：domain.com/cgi/echo/getloc?gettest=abc