使用Python寫Windows Service服務程序

1.背景

如果你想用Python開發Windows程序，並讓其開機啟動等，就必須寫成windows的服務程序Windows Service，用Python來做這個事情必須要借助第三方模塊pywin32，自己去下載然后安裝（注意下載符合自己OS的版本）

2.實例

先上代碼

#encoding=utf-8  
import win32serviceutil   
import win32service   
import win32event  
import os   
import logging  
import inspect
import servicemanager
  
class PythonService(win32serviceutil.ServiceFramework):   
  
    _svc_name_ = "PythonService"  #服務名 
    _svc_display_name_ = "Python Service Test"  #服務在windows系統中顯示的名稱
    _svc_description_ = "This is a python service test code "  #服務的描述
  
    def __init__(self, args):   
        win32serviceutil.ServiceFramework.__init__(self, args)   
        self.hWaitStop = win32event.CreateEvent(None, 0, 0, None)  
        self.logger = self._getLogger()  
        self.run = True  
          
    def _getLogger(self):  
          
        logger = logging.getLogger('[PythonService]')  
          
        this_file = inspect.getfile(inspect.currentframe())  
        dirpath = os.path.abspath(os.path.dirname(this_file))  
        handler = logging.FileHandler(os.path.join(dirpath, "service.log"))  
          
        formatter = logging.Formatter('%(asctime)s %(name)-12s %(levelname)-8s %(message)s')  
        handler.setFormatter(formatter)  
          
        logger.addHandler(handler)  
        logger.setLevel(logging.INFO)  
          
        return logger  
  
    def SvcDoRun(self):  
        import time  
        self.logger.info("service is run....")   
        while self.run:  
            self.logger.info("I am runing....")  
            time.sleep(2)  
              
    def SvcStop(self):   
        self.logger.info("service is stop....")  
        self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)   
        win32event.SetEvent(self.hWaitStop)   
        self.run = False  
  
if __name__=='__main__':   
    if len(sys.argv) == 1:
        try:
            evtsrc_dll = os.path.abspath(servicemanager.__file__)
            servicemanager.PrepareToHostSingle(PythonService)
            servicemanager.Initialize('PythonService', evtsrc_dll)
            servicemanager.StartServiceCtrlDispatcher()
        except win32service.error, details:
            if details[0] == winerror.ERROR_FAILED_SERVICE_CONTROLLER_CONNECT:
                win32serviceutil.usage()
    else:
        win32serviceutil.HandleCommandLine(PythonService)

解釋一下代碼：

1）.在類PythonService的__init__函數執行完后，系統服務開始啟動，windows系統會自動調用SvcDoRun函數，這個函數的執行不可以結束，因為結束就代表服務停止。所以當我們放自己的代碼在SvcDoRun函數中執行的時候，必須確保該函數不退出。

2）.當停止服務的時候，系統會調用SvcDoStop函數，該函數通過設置標志位等方式讓SvcDoRun函數退出，就是正常的停止服務。例子中是通過event事件讓SvcDoRun函數停止等待，從而退出該函數，從而使服務停止。系統關機時不會調用SvcDoStop函數，所以這種服務是可以設置為開機自啟的。

3.服務操作命令

#1.安裝服務

python PythonService.py install

#2.讓服務自動啟動

python PythonService.py --startup auto install 

#3.啟動服務

python PythonService.py start

#4.重啟服務

python PythonService.py restart

#5.停止服務

python PythonService.py stop

#6.刪除/卸載服務

python PythonService.py remove

4.使用pyinstaller打包exe

pyinstaller.exe -F -c winService.py

效果：

5.管理windows服務操作

#!/usr/bin/env python
# -*- coding: UTF8 -*-
#
import win32service
import win32con
import time, sys
import datetime
reload(sys)
sys.setdefaultencoding("utf8")
class ServiceManager(object):
    """管理window服務"""

    def __init__(self, name):
        """
        name: 服務的名稱
        """
        self.name = name
        
        #啟動或停止服務時等待操作成功等待時間
        self.wait_time = 0.5
        #啟動或停止服務時最大等待時間，超過時返回超時提示
        self.delay_time = 10
        self.scm = win32service.OpenSCManager(None, None, win32service.SC_MANAGER_ALL_ACCESS)


        if self.is_exists():
            try:
                self.handle = win32service.OpenService(self.scm, self.name, win32service.SC_MANAGER_ALL_ACCESS)
            except Exception, e:
                self.log(e)
        else:
            print '服務 %s 沒有安裝'.encode('gbk') % self.name
            

    def is_stop(self):
        """檢查服務是否停止"""
        flag = False
        try:
            if self.handle:
                ret = win32service.QueryServiceStatus(self.handle)
                flag = ret[1] != win32service.SERVICE_RUNNING
        except Exception, e:
            self.log(e)
        return flag

    def start(self):
        """開啟服務"""
        try:
            if self.handle:
                win32service.StartService(self.handle, None)
        except Exception, e:
            self.log(e)
        status_info = win32service.QueryServiceStatus(self.handle)

        if status_info[1] == win32service.SERVICE_RUNNING:
            return '啟動服務%s成功'.encode('gbk') % self.name
        elif status_info[1] == win32service.SERVICE_START_PENDING:
            #如果服務正在啟動中則延遲返回啟動信息，直到啟動成功,或返回啟動時間過長信息
            start_time = datetime.datetime.now()
            while True:
                if (datetime.datetime.now() - start_time).seconds > self.delay_time:
                    return '啟動服務%s時間太長'.encode('gbk') % self.name

                time.sleep(self.wait_time)
                if win32service.QueryServiceStatus(self.handle)[1] == win32service.SERVICE_RUNNING:
                    return '啟動服務%s成功'.encode('gbk') % self.name
        else:
            return '啟動服務%s失敗'.encode('gbk') % self.name

    def stop(self):
        """停止服務"""
        try:
            status_info = win32service.ControlService(self.handle, win32service.SERVICE_CONTROL_STOP)
        except Exception, e:
            self.log(e)
        if status_info[1] == win32service.SERVICE_STOPPED:
            return '停止服務%s成功'.encode('gbk') % self.name
        elif status_info[1] == win32service.SERVICE_STOP_PENDING:
            start_time = datetime.datetime.now()
            while True:
                if (datetime.datetime.now() - start_time).seconds > self.delay_time:
                    return '停止服務%s時間太長'.encode('gbk') % self.name

                time.sleep(self.wait_time)
                if win32service.QueryServiceStatus(self.handle)[1] == win32service.SERVICE_STOPPED:
                    return '停止服務%s成功'.encode('gbk') % self.name
        else:
            return '停止服務%s失敗'.encode('gbk') % self.name

    def restart(self):
        """重啟服務"""
        if not self.is_stop():
            self.stop()
        self.start()
        return win32service.QueryServiceStatus(self.handle)

    def status(self):
        """獲取運行的狀態"""
        try:
            status_info = win32service.QueryServiceStatus(self.handle)
            status = status_info[1]
            if status == win32service.SERVICE_STOPPED:
                return "STOPPED"
            elif status == win32service.SERVICE_START_PENDING:
                return "STARTING"
            elif status == win32service.SERVICE_STOP_PENDING:
                return "STOPPING"
            elif status == win32service.SERVICE_RUNNING:
                return "RUNNING"
        except Exception, e:
            self.log(e)

    def close(self):
        """釋放資源"""
        try:
            if self.scm:
                win32service.CloseServiceHandle(self.handle)
                win32service.CloseServiceHandle(self.scm)
        except Exception, e:
            self.log(e)

    def is_exists(self):
        """windows服務是否已安裝"""
        statuses = win32service.EnumServicesStatus(self.scm, win32service.SERVICE_WIN32, win32service.SERVICE_STATE_ALL)
        for (short_name, desc, status) in statuses:
            if short_name == self.name:
                return True
        return False

    def log(self, exception):
        
        print(exception)
        
        

if __name__=='__main__':

    app= ServiceManager('PythonService')
    msg= app.is_exists()  # 判斷是否安裝  （以下操作必須先判斷服務是否存在）
    #msg= app.is_stop()  # 判斷服務是否停止
    #msg= app.status()  # 查看服務的狀態
    #msg= app.start()  # 開啟服務
    #msg= app.stop()  # 暫停服務   （服務開啟才能停止，else error）
    #msg= app.restart()  # 重啟服務
    
    print(msg)