进程信号

转载:http://blog.csdn.net/ljx0305/archive/2008/09/09/2904056.aspx

SIGHUP 终止进程 终端线路挂断
SIGINT 终止进程 中断进程
SIGQUIT 建立CORE文件终止进程,并且生成core文件
SIGILL 建立CORE文件 非法指令
SIGTRAP 建立CORE文件 跟踪自陷
SIGBUS 建立CORE文件 总线错误
SIGSEGV 建立CORE文件 段非法错误
SIGFPE 建立CORE文件 浮点异常
SIGIOT 建立CORE文件 执行I/O自陷
SIGKILL 终止进程 杀死进程
SIGPIPE 终止进程 向一个没有读进程的管道写数据
SIGALARM 终止进程 计时器到时
SIGTERM 终止进程 软件终止信号
SIGSTOP 停止进程 非终端来的停止信号
SIGTSTP 停止进程 终端来的停止信号
SIGCONT 忽略信号 继续执行一个停止的进程
SIGURG 忽略信号 I/O紧急信号
SIGIO 忽略信号 描述符上可以进行I/O
SIGCHLD 忽略信号 当子进程停止或退出时通知父进程
SIGTTOU 停止进程 后台进程写终端
SIGTTIN 停止进程 后台进程读终端
SIGXGPU 终止进程 CPU时限超时
SIGXFSZ 终止进程 文件长度过长
SIGWINCH 忽略信号 窗口大小发生变化
SIGPROF 终止进程 统计分布图用计时器到时
SIGUSR1 终止进程 用户定义信号1
SIGUSR2 终止进程 用户定义信号2
SIGVTALRM 终止进程 虚拟计时器到时

1) SIGHUP 本信号在用户终端连接(正常或非正常)结束时发出, 通常是在终端的控
制进程结束时, 通知同一session内的各个作业, 这时它们与控制终端
不再关联.
2) SIGINT 程序终止(interrupt)信号, 在用户键入INTR字符(通常是Ctrl-C)时发出
3) SIGQUIT 和SIGINT类似, 但由QUIT字符(通常是Ctrl-)来控制. 进程在因收到
SIGQUIT退出时会产生core文件, 在这个意义上类似于一个程序错误信
号.
4) SIGILL 执行了非法指令. 通常是因为可执行文件本身出现错误, 或者试图执行
数据段. 堆栈溢出时也有可能产生这个信号.
5) SIGTRAP 由断点指令或其它trap指令产生. 由debugger使用.
6) SIGABRT 程序自己发现错误并调用abort时产生.
6) SIGIOT 在PDP-11上由iot指令产生, 在其它机器上和SIGABRT一样.
7) SIGBUS 非法地址, 包括内存地址对齐(alignment)出错. eg: 访问一个四个字长
的整数, 但其地址不是4的倍数.
8) SIGFPE 在发生致命的算术运算错误时发出. 不仅包括浮点运算错误, 还包括溢
出及除数为0等其它所有的算术的错误.
9) SIGKILL 用来立即结束程序的运行. 本信号不能被阻塞, 处理和忽略.
10) SIGUSR1 留给用户使用
11) SIGSEGV 试图访问未分配给自己的内存, 或试图往没有写权限的内存地址写数据.
12) SIGUSR2 留给用户使用
13) SIGPIPE Broken pipe
14) SIGALRM 时钟定时信号, 计算的是实际的时间或时钟时间. alarm函数使用该
信号.
15) SIGTERM 程序结束(terminate)信号, 与SIGKILL不同的是该信号可以被阻塞和
处理. 通常用来要求程序自己正常退出. shell命令kill缺省产生这
个信号.
17) SIGCHLD 子进程结束时, 父进程会收到这个信号.
18) SIGCONT 让一个停止(stopped)的进程继续执行. 本信号不能被阻塞. 可以用
一个handler来让程序在由stopped状态变为继续执行时完成特定的
工作. 例如, 重新显示提示符
19) SIGSTOP 停止(stopped)进程的执行. 注意它和terminate以及interrupt的区别:
该进程还未结束, 只是暂停执行. 本信号不能被阻塞, 处理或忽略.
20) SIGTSTP 停止进程的运行, 但该信号可以被处理和忽略. 用户键入SUSP字符时
(通常是Ctrl-Z)发出这个信号
21) SIGTTIN 当后台作业要从用户终端读数据时, 该作业中的所有进程会收到SIGTTIN
信号. 缺省时这些进程会停止执行.
22) SIGTTOU 类似于SIGTTIN, 但在写终端(或修改终端模式)时收到.
23) SIGURG 有”紧急”数据或out-of-band数据到达socket时产生.
24) SIGXCPU 超过CPU时间资源限制. 这个限制可以由getrlimit/setrlimit来读取/
改变
25) SIGXFSZ 超过文件大小资源限制.
26) SIGVTALRM 虚拟时钟信号. 类似于SIGALRM, 但是计算的是该进程占用的CPU时间.
27) SIGPROF 类似于SIGALRM/SIGVTALRM, 但包括该进程用的CPU时间以及系统调用的
时间.
28) SIGWINCH 窗口大小改变时发出.
29) SIGIO 文件描述符准备就绪, 可以开始进行输入/输出操作.
30) SIGPWR Power failure

有两个信号可以停止进程:SIGTERM和SIGKILL。 SIGTERM比较友好,进程能捕捉这个信号,根据您的需要来关闭程序。在关闭程序之前,您可以结束打开的记录文件和完成正在做的任务。在某些情况下,假如进程正在进行作业而且不能中断,那么进程可以忽略这个SIGTERM信号。

对于SIGKILL信号,进程是不能忽略的。这是一个 “我不管您在做什么,立刻停止”的信号。假如您发送SIGKILL信号给进程,Linux就将进程停止在那里。

用Python写简单守护进程【转】

[转载自]http://www.jejik.com/articles/2007/02/a_simple_unix_linux_daemon_in_python/

I’ve written a simple Python class for creating daemons on unix/linux systems. It was pieced together for various other examples, mostly corrections to various Python Cookbook articles and a couple of examples posted to the Python mailing lists. It has support for a pidfile to keep track of the process. I hope it’s useful to someone.

Below is the Daemon class. To use it, simply subclass it and implement the run() method. Download this file.

#!/usr/bin/env python

import sys, os, time, atexit
from signal import SIGTERM 

class Daemon:
    """
    A generic daemon class.
    
    Usage: subclass the Daemon class and override the run() method
    """
    def __init__(self, pidfile, stdin='/dev/null', stdout='/dev/null', stderr='/dev/null'):
        self.stdin = stdin
        self.stdout = stdout
        self.stderr = stderr
        self.pidfile = pidfile
    
    def daemonize(self):
        """
        do the UNIX double-fork magic, see Stevens' "Advanced 
        Programming in the UNIX Environment" for details (ISBN 0201563177)
        http://www.erlenstar.demon.co.uk/unix/faq_2.html#SEC16
        """
        try: 
            pid = os.fork() 
            if pid > 0:
                # exit first parent
                sys.exit(0) 
        except OSError, e: 
            sys.stderr.write("fork #1 failed: %d (%s)\n" % (e.errno, e.strerror))
            sys.exit(1)
    
        # decouple from parent environment
        os.chdir("/") 
        os.setsid() 
        os.umask(0) 
    
        # do second fork
        try: 
            pid = os.fork() 
            if pid > 0:
                # exit from second parent
                sys.exit(0) 
        except OSError, e: 
            sys.stderr.write("fork #2 failed: %d (%s)\n" % (e.errno, e.strerror))
            sys.exit(1) 
    
        # redirect standard file descriptors
        sys.stdout.flush()
        sys.stderr.flush()
        si = file(self.stdin, 'r')
        so = file(self.stdout, 'a+')
        se = file(self.stderr, 'a+', 0)
        os.dup2(si.fileno(), sys.stdin.fileno())
        os.dup2(so.fileno(), sys.stdout.fileno())
        os.dup2(se.fileno(), sys.stderr.fileno())
    
        # write pidfile
        atexit.register(self.delpid)
        pid = str(os.getpid())
        file(self.pidfile,'w+').write("%s\n" % pid)
    
    def delpid(self):
        os.remove(self.pidfile)

    def start(self):
        """
        Start the daemon
        """
        # Check for a pidfile to see if the daemon already runs
        try:
            pf = file(self.pidfile,'r')
            pid = int(pf.read().strip())
            pf.close()
        except IOError:
            pid = None
    
        if pid:
            message = "pidfile %s already exist. Daemon already running?\n"
            sys.stderr.write(message % self.pidfile)
            sys.exit(1)
        
        # Start the daemon
        self.daemonize()
        self.run()

    def stop(self):
        """
        Stop the daemon
        """
        # Get the pid from the pidfile
        try:
            pf = file(self.pidfile,'r')
            pid = int(pf.read().strip())
            pf.close()
        except IOError:
            pid = None
    
        if not pid:
            message = "pidfile %s does not exist. Daemon not running?\n"
            sys.stderr.write(message % self.pidfile)
            return # not an error in a restart

        # Try killing the daemon process    
        try:
            while 1:
                os.kill(pid, SIGTERM)
                time.sleep(0.1)
        except OSError, err:
            err = str(err)
            if err.find("No such process") > 0:
                if os.path.exists(self.pidfile):
                    os.remove(self.pidfile)
            else:
                print str(err)
                sys.exit(1)

    def restart(self):
        """
        Restart the daemon
        """
        self.stop()
        self.start()

    def run(self):
        """
        You should override this method when you subclass Daemon. It will be called after the process has been
        daemonized by start() or restart().
        """

And here is an example implementation. It implements the daemon as well as it’s controlling client. Simply invoke this script with start, stop or restart as it’s first argument. Download this file.

#!/usr/bin/env python

import sys, time
from daemon import Daemon

class MyDaemon(Daemon):
    def run(self):
        while True:
            time.sleep(1)

if __name__ == "__main__":
    daemon = MyDaemon('/tmp/daemon-example.pid')
    if len(sys.argv) == 2:
        if 'start' == sys.argv[1]:
            daemon.start()
        elif 'stop' == sys.argv[1]:
            daemon.stop()
        elif 'restart' == sys.argv[1]:
            daemon.restart()
        else:
            print "Unknown command"
            sys.exit(2)
        sys.exit(0)
    else:
        print "usage: %s start|stop|restart" % sys.argv[0]
        sys.exit(2)

Django and Memcached

just ran into several problems while setting up memcached for a django installation, that is replicated over several servers. One of the problems was the compiling of cmemcache, a python extension for libmemcache, where I received the following error:

‘CmemcacheObject’ has no member named ‘mc_ctxt’

First I didn’t realized the additional file, that resides at the file list of downloadable cmemcache versions. With this file you can patch the libmemcache library so cmemcache can be build. Here the steps to compile and install cmemcache:

cd ~
wget http://people.freebsd.org/~seanc/libmemcache/libmemcache-1.4.0.rc2.tar.bz2
wget http://gijsbert.org/downloads/cmemcache/libmemcache-1.4.0.rc2.patch
wget http://gijsbert.org/downloads/cmemcache/cmemcache-0.95.tar.bz2
# the patch was made using a folder called reference
mkdir reference
cd reference
tar xjvf ../libmemcache-1.4.0.rc2.tar.bz2
cd ..
patch -p0 < libmemcache-1.4.0.rc2.patch cd reference/libmemcache-1.4.0.rc2 ./configure && make sudo make install cd ../../ tar xjvf cmemcache-0.95.tar.bz2 cd cmemcache-0.95 ./configure && make sudo make install After doing these steps you should be able to do this in your python console: import cmemcache Instead of the cmemcache library you can also install python-memcache, that is a memcache library completely written in python. But the cmemcache is definitely faster and if you have installed both libraries, django will favor the c implementation in front of the python one. The other problem with memcached and django relies on a misunderstanding of mine. I thought, that if I define several memcached instances in my CACHE_BACKEND setting of django, it sends every new or changed key/value pair to each server in the list and holds each one redundant on all memcached instances. So I’ve defined the following CACHE_BACKEND setting on Django Server A (192.168.1.1): CACHE_BACKEND = 'memcached://192.168.1.1:11211;192.168.1.2:11211/' and on Django Server B (192.168.1.2): CACHE_BACKEND = 'memcached://192.168.1.2:11211;192.168.1.1:11211/' and assumed, when a request on the cache was made, that Django Server B would first try to access the memcache instance on Server B. This assumption was totally wrong and on top of that I also recognized, that no saved cache-entry from Django Server A was available on Django Server B. So I’ve started to read the documentation of memcached and came across the following faq entry. There you can read, how memcached is working and how values are saved across several instances: When doing a memcached lookup, first the client hashes the key against the whole list of servers A result of this is, that the setting of CACHE_BACKEND for memcached servers must be the same on all django installations. Otherwise the hash for a key/value pair would be a different one on each server and you are not able to access cached values across the installations. Another result is, that a cascade of memcached servers act as one big cache server with the main goal to scale large. You never know on which of the memached servers your cached value is saved. Additional note! If you are running memcached instances on servers that are far distant from each other (like a server in Germany and one in the US), you shouldn’t use several memcached instances as one cluster. Replicate your memcached instances with the modified memcached server called repcached instead. Otherwise the cache lookups will be too slow. by http://blog.uxebu.com/2008/06/30/django-and-memcached/

Xtrabackup备份和恢复MySQL

Xtrabackup是一个对InnoDB做数据备份的工具,支持在线热备份(备份时不影响数据读写),是商业备份工具InnoDB Hotbackup的一个很好的替代品。Xtrabackup中包含两个工具:

* xtrabackup – 用于热备份innodb, xtradb表的工具,不能备份其他表。
* innobackupex – 对xtrabackup封装的perl脚本,提供了myisam表备份的能力。

Xtrabackup可以做什么

* 在线(热)备份整个库的InnoDB, XtraDB表
* 在xtrabackup的上一次整库备份基础上做增量备份(innodb only)
* 以流的形式产生备份,可以直接保存到远程机器上(本机硬盘空间不足时很有用)

Xtrabackup如何工作的

* xtrabackup – 具体原理有待研究。。。
* innobackupex整库备份
1. 调用xtrabackup对innodb表空间文件(这一瞬间的映像Time1)备份,而在这个innodb表备份期间数据库是不加锁的,外部可以继续往库里增减数据(这才能叫热备份)。而在Time1和Time2这两个时间点之间的改动由一个线程不断地扫innodb log获得(ChangeSet1)。
2. 锁所有库。
3. 以直接拷贝的方式备份frm,MYD,MYI,MRG,TRG,TRN,opt格式的文件。
4. 步骤3中的数据备份完毕时(Time2),停止扫innodb log的线程,把ChangeSet1的数据拷贝到备份中。
5. 解锁所有库。
6. 终止挂起,备份完毕。

注意要点

* 根据innobackupex的原理可知它不是真正的热备份,MyISAM表越少越小就越有利。要利用Xtrabackup的好处就尽量用innodb表。
* 还原备份前关闭mysql服务;还原备份后检查数据文件权限是否正确。
* 性能:备份一个数据目录总大小5.6G,其中ibdata 2G,总时间4分钟,锁表时间2.5分钟。如果用mysqldump做这个库的备份锁表时间是5-8倍。

安装

tar zxf xtrabackup-0.7.tar.gz
cd xtrabackup-0.7
./configure
make

进行到这里时,千万别惯性使用make install,那样就会接着安装MySQL了,正确方法是接着:

cd innobase/xtrabackup/
make
make install

然后,就会在你的/usr/bin目录里安装上两个工具:xtrabackup,innobackupex-1.5.1

# 制定备份多个数据库

innobackupex-1.5.1 --user=root --databases="innodb innodb2" /bak/

# 压缩备份(不加–databases,默认全部数据库)

innobackupex-1.5.1 --user=root --stream=tar /bak/ | gzip > /bak/bak.tar.gz

(解压缩必须加i。innobackupex: You must use -i (–ignore-zeros) option for extraction of the tar stream.)

# 远程备份到192.168.1.200的/bak目录下。

innobackupex-1.5.1 --user=root --stream=tar /bak | ssh root@192.168.1.200 cat ">" /bak/backup.tar

恢复

# innobackup-1.5.1 --apply-log  /bak/2009_0929/
# innobackup-1.5.1 --copy-back  /bak/2009_0929/
# chown -R mysql:mysql /usr/local/mysql/data/*
# mysqladmin -uroot -p123456 shutdown
# mysqld_safe --user=mysql &

TCP连接状态

CLOSED: 表示初始状态。

LISTEN: 表示服务器端的某个SOCKET处于监听状态,可以接受连接。

SYN_SENT:在服务端监听后,客户端SOCKET执行CONNECT连接时,客户端发送SYN报文,此时客户端就进入SYN_SENT状态,等待服务端的确认

SYN_RCVD: 表示服务端接受到了SYN报文,在正常情况下,这个状态是服务器端的SOCKET在建立TCP连接时的三次握手会话过程中的一个中间状态,很短暂,基本上用netstat你是很难看到这种状态的,除非你特意写了一个客户端测试程序,故意将三次TCP握手过程中最后一个ACK报文不予发送。因此这种状态时,当收到客户端的ACK报文后,它会进入到ESTABLISHED状态。

ESTABLISHED:表示连接已经建立了。

FIN_WAIT_1: 这个是已经建立连接之后,其中一方请求终止连接,等待对方的FIN报文。FIN_WAIT_1状态是当SOCKET在ESTABLISHED状态时,它想主动关闭连接,向对方发送了FIN报文,此时该SOCKET即进入到FIN_WAIT_1状态。而当对方回应ACK报文后,则进入到FIN_WAIT_2状态,当然在实际的正常情况下,无论对方何种情况下,都应该马上回应ACK报文,所以FIN_WAIT_1状态一般是比较难见到的,而FIN_WAIT_2状态还有时常常可以用netstat看到。

FIN_WAIT_2:实际上FIN_WAIT_2状态下的SOCKET,表示半连接,也即有一方要求close连接,但另外还告诉对方,我暂时还有点数据需要传送给你,稍后再关闭连接。

TIME_WAIT: 表示收到了对方的FIN报文,并发送出了ACK报文,就等2MSL后即可回到CLOSED可用状态了。如果FIN_WAIT_1状态下,收到了对方同时带FIN标志和ACK标志的报文时,可以直接进入到TIME_WAIT状态,而无须经过FIN_WAIT_2状态。

CLOSING: 这种状态比较特殊,实际情况中应该是很少见,属于一种比较罕见的例外状态。正常情况下,当你发送FIN报文后,按理来说是应该先收到(或同时收到)对方的ACK报文,再收到对方的FIN报文。但是CLOSING状态表示你发送FIN报文后,并没有收到对方的ACK报文,反而却也收到了对方的FIN报文。什么情况下会出现此种情况呢?其实细想一下,也不难得出结论:那就是如果双方几乎在同时close一个SOCKET的话,那么就出现了双方同时发送FIN报文的情况,也即会出现CLOSING状态,表示双方都正在关闭SOCKET连接。

CLOSE_WAIT: 这种状态的含义其实是表示在等待关闭。怎么理解呢?当对方close一个SOCKET后发送FIN报文给自己,你系统毫无疑问地会回应一个ACK报文给对方,此时则进入到CLOSE_WAIT状态。接下来呢,实际上你真正需要考虑的事情是察看你是否还有数据发送给对方,如果没有的话,那么你也就可以close这个SOCKET,发送FIN报文给对方,也即关闭连接。所以你在CLOSE_WAIT状态下,需要完成的事情是等待你去关闭连接。

LAST_ACK: 这个状态还是比较容易好理解的,它是被动关闭一方在发送FIN报文后,最后等待对方的ACK报文。当收到ACK报文后,也即可以进入到CLOSED可用状态了。

windows下开发并编译PHP扩展(步骤说明)

开发PHP扩展对于普通程序员来讲可能一直是一件很神秘的工作,其实,只要你对C语言熟悉,了解了开发PHP扩展的步骤和规则,开发PHP扩展也是一件很普通的工作。
现在就简单说一在WINDOWS下开发PHP扩展的步骤:
首先需要准备的软件有:
cygwin 安装路径e:\app\cygwin
visual studio C++ 6.0,
修改环境变量,把已经安装好的PHP路径设置为环境变量。在这里,假设我的PHP安装目录是:e:\app\php5.2.5,那么我把WINDOWS环境变量后面加上这个安装目录。方便一会儿使用php.exe。
PHP源代码,这里假设为e:\c_source_code\php-5.2.5

1、修改文件 “PHP源文件目录/ext/ext_skel_win32.php”,在这里就是:E:\c_source_code\php-5.2.5\ext,其中主要是修改其中的cygwin路径。$cygwin_path = ‘e:\app\cygwin\bin’;
把$cygwin_path修改为你实际安装cygwin的路径。
2、在源代码ext目录也就是e:\c_source_code\php-5.2.5\ext下,执行 php ext_skel_win32.php –extname=,此时会在ext目录下生成目录,这个目录就是我们将要进行PHP扩展开发的框架。比如你运行php.exe ext_skel_win32.php –extname=foo,会在ext目录下生成foo目录。
3、将php-root\dev\php5ts.lib拷贝至 “ext/”中。比如你要开发的PHP扩展名为foo,那么就需要把php-root\dev\php5ts.lib拷贝到PHP源文件目录\ext\foo中。
4、修改foo.c内容,编写我们需要的C代码。
5、进入目录,打开.dsp。
设置VC6工程,
设置菜单“组建”->“移除工程配置”,选中“Win 32 Release_TS”,
设置菜单“工程”,选中“Win 32 Release_TS”
打开Tab“连接”,设置“输出文件名”中的目录,
[可选]打开Tab“C/C++”,增加“预处理器定义”“,COMPILE_DL_”(注意全大写,默认加入的),取消预定义“LIBZEND_EXPORTS”(否则不可引入zend函数)。
6、设置好以后,进行编译,会生成一个dll文件,文件名是.dll,比如在我们的例子中就为foo.dll
把foo.dll拷到e:\app\ext目录下,并在php.ini里加上一行extension=foo.dll,重启一下apache,查看phpinfo();,会发现我们的PHP扩展foo()已经加载进来,已经可以使用这个foo扩展了。

http://info.codepub.com/2008/08/info-21426.html

(转)整理了一份比较全面的PHP开发编码规范

这些年来多从事Linux下PHP和C相关的开发,带过很多项目和团队,下面是根据经验整理的PHP编码规范,可以用作给大家的范例和参考,根据需要进行取舍和修改!

(可能最新的一些php5的规范不够完整,今后有机会保持更新!)

目录
1 编写目的
2 整体要求
3 安全规范
3.1 包含文件
3.1.1 命名规则
3.1.2 存放规则
3.2 安全规则
3.3 一些针对PHP的规则
3.4 其它处理规则
3.4.1 对输入参数值进行转义处理
3.4.2 操作大HTML文本

4 编码规范
4.1 命名规范
4.1.1 变量命名
4.1.2 类
4.1.3 方法或函数
4.1.4 缩写词
4.1.5 数据库表名
4.1.6 数据库字段
4.2 书写规则
4.2.1 代码缩进
4.2.2 大括号{ }书写规则
4.2.3 小括号( )和函数、关键词等
4.2.4 =符号书写
4.2.5 if else swith for while等书写
4.2.6 类的构造函数
4.2.7 语句断行, 每行控制在80个字符以内
4.2.8 不要不可思议的数字
4.2.9 true/false和0/1判断
4.2.10 避免嵌入式赋值
4.2.11 错误返回检测规则
4.3 程序注释
4.3.1 程序头注释块
4.3.2 类的注释
4.3.3 函数和方法的注释
4.3.4 变量或者语句注释
4.4 其他规范(建议)
4.4.1 php代码标记
4.4.2 程序文件名、目录名
4.4.3 PHP项目通常的文件目录结构
4.4.4 PHP和HTML代码的分离问题
4.4.5 PHP项目开发中的程序逻辑结构
5 特定环境下PHP编码特殊规范
5.1 变量定义
5.2 引用的使用
5.3 变量的输入输出

1 编写目的
为了更好的提高技术部的工作效率,保证开发的有效性和合理性,并可最大程度的提高程序代码的可读性和可重复利用性,指定此规范。开发团队根据自己的实际情况,可以对本规范进行补充或裁减。

2 整体要求
技术部php开发规范将参照PEAR的规范,基本采用PEAR指定的规范,在其基础上增加、修改或删除部分适合具体开发环境的规范。本规范只针对PHP开发过程中编码的规范,对于PHP开发项目中文件、目录、数据库等方面的规范,将不重点涉及。
本规范包含了PHP开发时程序编码中命名规范、代码缩进规则、控制结构、函数调用、函数定义、注释、包含代码、PHP标记、文件头的注释块、CVS标记、URL样例、常量命名等方面的规则。

3 安全规范

3.1 包含文件

3.1.1 命名规则
提取出来具有通用函数的包含文件,文件后缀以.inc来命名,表明这是一个包含文件。
如果有多个.inc文件需要包含多页面,请把所有.inc文件封装在一个文件里面,具体到页面只需要包换一个.inc文件就可以了
如:xxx_session.inc
xxx_comm..inc
xxx_setting.inc
mysql_db.inc

把以上文件以一下方式,封装在xxx.basic.inc文件里面
require_once(”xxx_session.inc”);
require_once(”xxx_comm.inc”);
require_once(”xxx_setting.inc”);
require_once(”mysql_db.inc”);

注:是否需要封装到一个文件,视情况而定,如果每个inc的功能是分散到不同的页面使用的话,就不建议封装。

3.1.2 存放规则
一般包含文件不需要直接暴露给用户,所以应该放在 Web Server访问不到的目录,避免因为配置问题而泄露设置信息。

3.2 安全规则
请参考产品安全检查表。

输入和输出
检查是否做了HTML代码的过滤
可能出现的问题:如果有人输入恶意的HTML代码,会导致窃取cookie, 产生恶意登录表单,和破坏网站
检查变量做数据库操作之前是否做了escape
可能出现的问题:如果一个要写入查询语句的字符串变量包含了某些特殊的字符,比如引号(’ ,”)或者分号(;) 可能造成执行了预期之外的操作。
建议采用的方法:使用mysql_escape_string() 或实现类似功能的函数。
检查输入数值的合法性
可能出现的问题:异常的数值会造成问题。如果对输入的数值不做检查会造成不合法的或者错误的数据存入UDB、存入其它的数据库或者导致意料之外的程序操作发生。
举例:
如果程序以用户输入的参数值做为文件名,进行文件操作,恶意输入系统文件名会造成系统损毁。
核实对cookie的使用以及对用户数据的处理
可能出现的问题:不正确的cookie使用可能造成用户数据泄漏
访问控制
对内部使用的产品或者供合作方使用的产品,要考虑增加访问控制
logs
确保用户的保密信息没有记在log中(例如:用户的密码)
确保对关键的用户操作保存了完整的用户访问记录
https
对敏感数据的传输要采用https

3.3 一些针对PHP的规则
设置 register_globals = off (Y!PHP 已经禁止了register_globals,如果你使用Y!PHP可以不考虑这项设置)
设置 error_reporting = E_ALL (Y!PHP 的缺省设置),并且要修正所有的error和warning
将实际的操作放在被引用的文件中。把引用文件放到不可以被直接浏览的目录下

3.4 其它处理规则

3.4.1 对输入参数值进行转义处理
页面接到参数需要SQL操作,这时候需要做转义,尤其需要注意”;”。
如:$a = ” Let’s go ” ;
$sql = “Insert into tmp(col) values(’$a’)” ;
这种情况出现错误的不确定性。

3.4.2 操作大HTML文本
很多时候需要存放一大段HTML文本供页面使用,象用户定制页头页脚等。
需要剔除脚本标记,避免执行恶意php代码。
转换”<"">“号,保证代码完整。

4 编码规范

4.1 命名规范
制定统一的命名规范对于项目开发来说非常重要,不但可以养成程序员一个良好的开发习惯,还能增加程序的可读性、可移植性和可重用性,还能很好的提高项目开发的效率。

4.1.1 变量命名
变量命名分为普通变量、静态变量、局部变量、全局变量、Session变量等方面的命名规则。

4.1.1.1 普通变量
普通变量命名遵循以下规则:
a. 所有字母都使用小写;
b. 对于一个变量使用多个单词的,使用’_’作为每个词的间隔。
例如:$base_dir、$red_rose_price等

4.1.1.2 静态变量
静态变量命名遵循以下规则:
a. 静态变量使用小写的s_开头;
b. 静态变量所有字母都使用小写;
c. 多个单词组成的变量名使用’_’作为每个词的间隔。
例子:$s_base_dir、$s_red_rose_prise等。

4.1.1.3 局部变量
局部变量命名遵循以下规则:
a. 所有字母使用小写;
b. 变量使用’_’开头;
c. 多个单词组成的局部变量名使用’_’作为每个词间的间隔。
例子:$_base_dir、$_red_rose_price等。

4.1.1.4 全局变量
全局变量应该带前缀’g’,知道一个变量的作用域是非常重要的。
例如
global $gLOG_LEVEL;
global $gLOG_PATH;

4.1.1.5 全局常量
全局变量命名遵循以下规则:
a. 所有字母使用大写
b. 全局变量多个单词间使用’_’作为间隔。
例子:$BASE_DIR、$RED_ROSE_PRICE等。

4.1.1.6 session变量
session变量命名遵循以下规则:
a. 所有字母使用大写;
b. session变量名使用’S_’开头;
c. 多个单词间使用’_’间隔。
例子:$S_BASE_DIR、$S_RED_ROSE_PRICE等。

4.1.2 类
php中类命名遵循以下规则:
a. 以大写字母开头;
b. 多个单词组成的变量名,单词之间不用间隔,各个单词首字母大写。
例子:class MyClass 或class DbOracle等。

4.1.3 方法或函数
方法或函数命名遵循以下规则:
a. 首字母小写;
b. 多个单词间不使用间隔,除第一个单词外,其他单词首字母大写。
例子:function myFunction ()或function myDbOracle ()等。

4.1.4 缩写词
当变量名或者其他命名中遇到缩写词时,参照具体的命名规则,而不采用缩写词原来的全部大写的方式。
例子:function myPear(不是myPEAR) functio getHtmlSource(不是getHTMLSource)。

4.1.5 数据库表名
数据库表名命名遵循以下规范:
a. 表名均使用小写字母;
b. 对于普通数据表,使用_t结尾;
c. 对于视图,使用_v结尾;
d. 对于多个单词组成的表名,使用_间隔;
例子:user_info_t和book_store_v等

4.1.6 数据库字段
数据库字段命名遵循以下规范:
a. 全部使用小写;
b. 多个单词间使用_间隔。
例子:user_name、rose_price等。

4.2 书写规则
书写规则是指在编写php程序时,代码书写的规则,包括缩进、结构控制等方面规范:

4.2.1 代码缩进
在书写代码的时候,必须注意代码的缩进规则,我们规定代码缩进规则如下:
a. 使用4个空格作为缩进,而不使用tab缩进(对于ultraedit,可以进行预先设置)
例子:
for ( $i=0;$i<$count;$i++ ) { echo "test"; } 4.2.2 大括号{ }书写规则 在程序中进行结构控制代码编写,如if、for、while、switch等结构,大括号传统的有两种书写习惯,分别如下: a.{直接跟在控制语句之后,不换行,如 for ($i=0;$i<$count;$i++) { echo "test"; } b.{在控制语句下一行,如 for($i=0;$i<$count;$i++) { echo "test"; } 其中,a是PEAR建议的方式,但是从实际书写中来讲,这并不影响程序的规范和影响用phpdoc实现文档,所以可以根据个人习惯来采用上面的两种方式,但是要求在同一个程序中,只使用其中一种,以免造成阅读的不方便。 4.2.3 小括号( )和函数、关键词等 小括号、关键词和函数遵循以下规则: a. 不要把小括号和关键词紧贴在一起,要用一个空格间隔;如if ( $a<$b ); b. 小括号和函数名间没有空格;如$test = date("ymdhis"); c. 除非必要,不要在Return返回语句中使用小括号。 如Return $a; 4.2.4 =符号书写 在程序中=符号的书写遵循以下规则: a. 在=符号的两侧,均需留出一个空格;如$a = $b 、if ($a = = $b)等; b. 在一个申明块,或者实现同样功能的一个块中,要求=号尽量上下对其,左边可以为了保持对齐使用多个空格,而右边要求空一个空格;如下例: $testa = $aaa; $testaa = $bbb; $testaaa = $ccc; 4.2.5 if else swith for while等书写 对于控制结构的书写遵循以下规则: a. 在if条件判断中,如果用到常量判断条件,将常量放在等号或不等号的左边,例如: if ( 6 == $errorNum ),因为如果你在等式中漏了一个等号,语法检查器会为你报错,可以很快找到错误位置,这样的写法要多注意; b. switch结构中必须要有default块; c. 在for和wiile的循环使用中,要警惕continue、break的使用,避免产生类似goto的问题; 4.2.6 类的构造函数 如果要在类里面编写构造函数,必须遵循以下规则: a. 不能在构造函数中有太多实际操作,顶多用来初始化一些值和变量; b. 不能在构造函数中因为使用操作而返回false或者错误,因为在声明和实例化一个对象的时候,是不能返回错误的; 4.2.7 语句断行, 每行控制在80个字符以内 在代码书写中,遵循以下原则: a. 尽量保证程序语句一行就是一句,而不要让一行语句太长产生折行; b. 尽量不要使一行的代码太长,一般控制在80个字符以内; c. 如果一行代码太长,请使用类似 .= 的方式断行书写; d. 对于执行数据库的sql语句操作,尽量不要在函数内写sql语句,而先用变量定义sql语句,然后在执行操作的函数中调用定义的变量; 例子: $sql = "SELECT username,password,address,age,postcode FROM test_t "; $sql .= " WHERE username='aaa'"; $res = mysql_query($sql); 4.2.8 不要不可思议的数字 一个在源代码中使用了的赤裸裸的数字是不可思议的数字,因为包括作者,在三个月内,没人它的含义。例如: if (22 == $foo) { start_thermo_nuclear_war(); } else if (19 == $foo) { refund_lotso_money(); } else { cry_cause_im_lost(); } 你应该用define()来给你想表示某样东西的数值一个真正的名字,而不是采用赤裸裸的数字,例如: define("PRESIDENT_WENT_CRAZY", "22"); define("WE_GOOFED", "19"); define("THEY_DIDNT_PAY", "16"); if ( PRESIDENT_WENT_CRAZY == $foo) { start_thermo_nuclear_war(); } else if (WE_GOOFED == $foo) { refund_lotso_money(); } else if (THEY_DIDNT_PAY == $foo) { infinite_loop(); } else { happy_days_i_know_why_im_here(); } 4.2.9 true/false和0/1判断 遵循以下规则: a. 不能使用0/1代替true/false,在PHP中,这是不相等的; b. 不要使用非零的表达式、变量或者方法直接进行true/false判断,而必须使用严格的完整true/false判断; 如:不使用if ($a) 或者if (checka()) 而使用if (FALSE != $a)或者 if (FALSE != check()) 4.2.10 避免嵌入式赋值 在程序中避免下面例子中的嵌入式赋值: 不使用这样的方式: while ($a != ($c = getchar())) { process the character } 4.2.11 错误返回检测规则 检查所有的系统调用的错误信息,除非你要忽略错误。 为每条系统错误消息定义好系统错误文本,并记录错误LOG。 4.3 程序注释 每个程序均必须提供必要的注释,书写注释要求规范,参照PEAR提供的注释要求,为今后利用phpdoc生成php文档做准备。程序注释的原则如下: a. 注释中除了文件头的注释块外,其他地方都不使用//注释,而使用/* */的注释; b. 注释内容必须写在被注释对象的前面,不写在一行或者后面; 4.3.1 程序头注释块 每个程序头部必须有统一的注释块,规则如下: a. 必须包含本程序的描述; b. 必须包含作者; c. 必须包含书写日期; d. 必须包含版本信息; e. 必须包含项目名称; f. 必须包含文件的名称; g. 重要的使用说明,如类的调用方法、注意事项等; 参考例子如下: |
// | Tomas V.V.Cox |
// | |
// +———————————————————+
//
// $Id: Common.php,v 1.8.2.3 2001/11/13 01:26:48 ssb Exp $
4.3.2 类的注释
类的注释采用里面的参考例子方式:

/**
* @ Purpose:
* 访问数据库的类,以ODBC作为通用访问接口
* @Package Name: Database
* @Author: Forrest Gump gump@crtvu.edu.cn
* @Modifications:
* No20020523-100:
* odbc_fetch_into()参数位置第二和第三个位置调换
* John Johnson John@crtvu.edu.cn
* @See: (参照)
*/
class Database
{
……
}
4.3.3 函数和方法的注释
函数和方法的注释写在函数和方法的前面,采用类似下面例子的规则:

/**
* @Purpose:
* 执行一次查询
* @Method Name: Query()
*
* @Param: string $queryStr SQL查询字符串
* @Param: string $username 用户名
*
* @Author: Michael Lee
*
* @Return: mixed 查询返回值(结果集对象)
*/
function($queryStr,$username)
{……}
4.3.4 变量或者语句注释
程序中变量或者语句的注释遵循以下原则:
a. 写在变量或者语句的前面一行,而不写在同行或者后面;
b. 注释采用/* */的方式;
c. 每个函数前面要包含一个注释块。内容包括函数功能简述,输入/输出参数,预期的返回值,出错代码定义。
d. 注释完整规范。
e. 把已经注释掉的代码删除,或者注明这些已经注释掉的代码仍然保留在源码中的特殊原因。
f.
例子:

/**
* @Purpose:
* 数据库连接用户名
* @Attribute/Variable Name: db_user_name
* @Type: string
*/
var db_user_name;

4.4 其他规范(建议)

4.4.1 php代码标记
所有的php程序代码块标记均使用

4.4.2 程序文件名、目录名
程序文件名和目录名命名均采用有意义的英文方式命名,不使用拼音或无意义的字母,同时均必须使用小写字母,多个词间使用_间隔。

4.4.3 PHP项目通常的文件目录结构
建议在开发规范的独立的PHP项目时,使用规范的文件目录结构,这有助于提高项目的逻辑结构合理性,对应扩展和合作,以及团队开发均有好处。
一个完整独立的PHP项目通常的文件和目录结构如下:
/ 项目根目录
/manage 后台管理文件存放目录
/css css文件存放目录
/doc 存放项目文档
/images 所有图片文件存放路径(在里面根据目录结构设立子目录)
/scripts 客户端js脚本存放目录
/tpl 网站所有html的模版文件存放目录
/error.php 错误处理文件(可以定义到apache的错误处理中)

以上目录结构是通常的目录结构,根据具体应用的具体情况,可以考虑不用完全遵循,但是尽量做到规范化。

4.4.4 PHP和HTML代码的分离问题
对性能要求不是很高的项目和应用,我们建议不采用PHP和HTML代码直接混排的方式书写代码,而采用PHP和HTML代码分离的方式,即采用模版的方式处理,这样一方面对程序逻辑结构更加清晰有利,也有助于开发过程中人员的分工安排,同时还对日后项目的页面升级该版提供更多便利。
对于一些特殊情况,比如对性能要求很高的应用,可以不采用模版方式。

4.4.5 PHP项目开发中的程序逻辑结构
对于PHP项目开发,尽量采用OOP的思想开发,尤其在PHP5以后,对于面向对象的开发功能大大提高。
在PHP项目中,我们建议将独立的功能模块尽量写成函数调用,对应一整块业务逻辑,我们建议封装成类,既可以提高代码可读性,也可以提高代码重用性。比如,我们通常将对数据库的接口封装成数据库类,有利于平台的移植。
重复的代码要做成公共的库。(除了我们在plug-in产品上遇到的情况,该产品系列有多个相类似的产品,为了尽可能地减少安装包尺寸,不适合将这些产品共用的所有函数做成公共的库)

5 特定环境下PHP编码特殊规范

5.1 变量定义
XXX环境下的php代码编写要求所有的变量均需要先申明后使用,否则会有错误信息,对于数组,在使用一个不确定的key时,比如先进行isset()的判断,然后再使用;比如下面的代码:
$array = array();
$var = isset($array[3]) ? $array[3] : “”;

5.2 引用的使用
引用在程序中使用比较多,为了公用同一个内存,而不需要另外进行复制,XXX环境下的引用使用时,需要注意下面的情况;
在对函数的输入参数中使用引用时,不能在调用的时候在输入参数前加&来引用,而直接使用该变量即可,同时必须在函数定义的时候说明输入参数来自引用,比如下面的代码:
$a = 1;
function ab(&$var)
{
$var ++;
return $var;
}
$b = ab($a) // 注意,此处不能使用 $b = ab(&$a)的方式;
echo $b.”\n”;
echo $a.”\n”;
此时 $a和$b都是2;

XXX环境下对引用的特殊要求源自php.ini文件里面的allow_call_time_pass_reference 项设置, 对外公开的版本是 On ,这样就可以支持&直接加到调用函数时变量前面进行引用,但是这一方法遭到抗议,并可能在将来版本的PHP/Zend里不再支持。受到鼓励的指定哪些参数按引用传递的方法是在函数声明里。你被鼓励尝试关闭这一选项(使用 off,XXX的所有运行环境下都是off)并确认你的脚本仍能正常工作,以保证在将来版本的语言里它们仍能工作。

5.3 变量的输入输出
在XXX环境下,对web通过GET或者POST方法传递来的参数均要求进行严格的过滤和合法性验证,不推荐使用直接的$_GET、$_POST或者$_REQUEST获取,而通过XXX的XXX_yiv模块提供的方法获取和过滤处理

规范完!

说明:规范中提到的XXX环境是特别指的xx曾经工作的XXX公司特定开发环境!

本文来自CSDN博客,转载请标明出处:http://blog.csdn.net/alexdream/archive/2008/03/24/2213313.aspx