自定义msi安装包的执行过程

时间：2023-12-11 19:33:38

有时候我们需要在程序中执行另一个程序的安装，这就需要我们去自定义msi安装包的执行过程。

比如我要做一个安装管理程序，可以根据用户的选择安装不同的子产品。当用户选择了三个产品时，如果分别显示这三个产品的安装交互UI显然是不恰当的。我们期望用一个统一的自定义UI去取代每个产品各自的UI。

平时使用msiexec.exe习惯了，所以最直接的想法就是在一个子进程中执行:

    msiexec.exe /qn

这样固然是能够完成任务，但是不是太简陋了？ 安装开始后我们想取消这次安装怎么办？ 或者我们还想要拿到一些安装进度的信息。

其实可以通过调用三个windowsAPI 轻松搞定这个事儿！下面的C# demo用一个自定义Form来指示多个MSI文件的安装过程。Form上放的是一个滚动条，并且配合一个不断更新的label。

下面是安装过程中的UI：

自定义msi安装包的执行过程

点击Cancel按钮取消安装后的UI：

自定义msi安装包的执行过程

先看一下这三个API：

[DllImport("msi.dll", CharSet = CharSet.Auto)]

internal static extern int MsiSetInternalUI(int dwUILevel, IntPtr phWnd);

在调用msiexec.exe时，我们通过指定 /q参数让安装过程显示不同的UI。如果不显示UI的话就要使用参数 /qn 。MsiSetInternalUI方法就是干这个事儿的。通过下面的调用就可以去掉msi中自带的UI：

NativeMethods.MsiSetInternalUI(2, IntPtr.Zero)

[DllImport("msi.dll", CharSet = CharSet.Auto)]

internal static extern MsiInstallUIHandler MsiSetExternalUI([MarshalAs(UnmanagedType.FunctionPtr)] MsiInstallUIHandlerpuiHandler, NativeMethods.InstallLogMode dwMessageFilter, IntPtr pvContext);

MsiSetExternalUI 函数允许指定一个用户定义的外部UI handler用来处理安装过程中产生的消息。这个外部的UI handler会在内部的UI handler被调用前调用。 如果在外部的UI handler中返回非0的值，就说明这个消息已经被处理。

这个外部的UI handler就是MsiSetExternalUI方法的第一个参数，我们通过实现这个handler来处理自己感兴趣的消息, 比如当安装进度变化后去更新进度条。或者通过它传递我们的消息给msi，比如说告诉msi，停止安装，执行cancel操作。使用这个方法需要注意的是，当你完成安装后一定要把原来的handler设回去。否则以后执行msi安装包可能会出问题。

MSDN上有一个MsiInstallUIHandler 的demo，感兴趣的同学可以看看。

[DllImport("msi.dll", CharSet = CharSet.Auto)]

internal static extern uint MsiInstallProduct([MarshalAs(UnmanagedType.LPWStr)] string szPackagePath,[MarshalAs(UnmanagedType.LPWStr)] string szCommandLine);

正如其名，这个是真正干活儿的方法。

实在忍不住要介绍第四个方法，虽然它对实现当前的功能来说是可选的，但对一个产品来说，它却是用来救命的。

[DllImport("msi.dll", CharSet = CharSet.Auto)]

internal static extern uint MsiEnableLog(GcMsiUtil.NativeMethods.InstallLogMode dwLogMode,[MarshalAs(UnmanagedType.LPWStr)] string szLogFile, uint dwLogAttributes);

这个方法会把安装log保存到你传递给它的文件路径。有了它生活就会happy很多，很多… 否则当用户告诉你安装失败时，你一定会抓狂的。

好了，下面是MyInstaller demo的主要代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
InstallProcessForm.cs
public partial class InstallProcessForm : Form
    {
        private MyInstaller _installer = null;
        private BackgroundWorker _installerBGWorker = new BackgroundWorker();
        internal InstallProcessForm()
        {
            InitializeComponent();
            _installer = new MyInstaller();
            _installerBGWorker.WorkerReportsProgress = true;
            _installerBGWorker.WorkerSupportsCancellation = true;
            _installerBGWorker.DoWork += _installerBGWorker_DoWork;
            _installerBGWorker.RunWorkerCompleted += _installerBGWorker_RunWorkerCompleted;
            _installerBGWorker.ProgressChanged += _installerBGWorker_ProgressChanged;
            this.Shown += InstallProcessForm_Shown;
        }
        private void InstallProcessForm_Shown(object sender, EventArgs e)
        {
            // 当窗口打开后就开始后台的安装
            _installerBGWorker.RunWorkerAsync();
        }
        private void _installerBGWorker_ProgressChanged(object sender, ProgressChangedEventArgs e)
        {
            // 消息通过 e.UserState 传回，并通过label显示在窗口上
            string message = e.UserState.ToString();
            this.label1.Text = message;
            if (message == "正在取消安装 ...")
            {
                this.CancelButton.Enabled = false;
            }
        }
        private void _installerBGWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
        {
            // 安装过程结束
        }
        private void _installerBGWorker_DoWork(object sender, DoWorkEventArgs e)
        {
            BackgroundWorker bgWorker = sender as BackgroundWorker;
            // 开始执行安装方法
            _installer = new MyInstaller();
            string msiFilePath = "xxx.msi"; // msi file path
            _installer.Install(bgWorker, msiFilePath);
        }
        private void CancelButton_Click(object sender, EventArgs e)
        {
            _installer.Canceled = true;
     _installerBGWorker.CancelAsync();
        }
}
MyInstaller.cs
internal class MyInstaller
    {
        private BackgroundWorker _bgWorker = null;
        public bool Canceled { get; set; }
        public void Install(BackgroundWorker bgWorker, string msiFileName)
        {
            _bgWorker = bgWorker;
            NativeMethods.MyMsiInstallUIHandler oldHandler = null;
            try
            {
                string logPath = "test.log";
                NativeMethods.MsiEnableLog(NativeMethods.LogMode.Verbose, logPath, 0u);
                NativeMethods.MsiSetInternalUI(2, IntPtr.Zero);
      oldHandler = NativeMethods.MsiSetExternalUI(new NativeMethods.MyMsiInstallUIHandler(MsiProgressHandler),
                                                NativeMethods.LogMode.ExternalUI,
                                                IntPtr.Zero);
                string param = "ACTION=INSTALL";
                _bgWorker.ReportProgress(0, "正在安装 xxx ...");
                NativeMethods.MsiInstallProduct(msiFileName, param);
            }
            catch(Exception e)
            {
                // todo
            }
            finally
            {
                // 一定要把默认的handler设回去。
                if(oldHandler != null)
                {
                    NativeMethods.MsiSetExternalUI(oldHandler, NativeMethods.LogMode.None, IntPtr.Zero);
                }
            }
        }
        //最重要的就是这个方法了，这里仅演示了如何cancel一个安装，更多详情请参考MSDN文档
        private int MsiProgressHandler(IntPtr context, int messageType, string message)
        {
            if (this.Canceled)
            {
                if (_bgWorker != null)
                {
                    _bgWorker.ReportProgress(0, "正在取消安装 ...");
                }
                // 这个返回值会告诉msi, cancel当前的安装
                return 2;
            }
            return 1;
        }
    }
    internal static class NativeMethods
    {
        [DllImport("msi.dll", CharSet = CharSet.Auto)]
        internal static extern int MsiSetInternalUI(int dwUILevel, IntPtr phWnd);
        [DllImport("msi.dll", CharSet = CharSet.Auto)]
        internal static extern MyMsiInstallUIHandler MsiSetExternalUI([MarshalAs(UnmanagedType.FunctionPtr)] <br>MyMsiInstallUIHandler puiHandler,<br> NativeMethods.LogMode dwMessageFilter, IntPtr pvContext);
        [DllImport("msi.dll", CharSet = CharSet.Auto)]
        internal static extern uint MsiInstallProduct([MarshalAs(UnmanagedType.LPWStr)] string szPackagePath, <br>[MarshalAs(UnmanagedType.LPWStr)]<br> string szCommandLine);
        [DllImport("msi.dll", CharSet = CharSet.Auto)]
        internal static extern uint MsiEnableLog(NativeMethods.LogMode dwLogMode, <br>[MarshalAs(UnmanagedType.LPWStr)] string szLogFile, <br>uint dwLogAttributes);
        internal delegate int MyMsiInstallUIHandler(IntPtr context, int messageType, <br>[MarshalAs(UnmanagedType.LPWStr)] string message);
        [Flags]
        internal enum LogMode : uint
        {
            None = 0u,
            Verbose = 4096u,
            ExternalUI = 20239u
        }
    }

　　

简单说明一下，用户定义的UI运行在主线程中，使用BackgroundWorker执行安装任务。在安装进行的过程中可以把cancel信息传递给MsiProgressHandler，当MsiProgressHandler检测到cancel信息后通过返回值告诉msi的执行引擎，执行cancel操作(msi的安装过程是相当严谨的，可不能简单的杀掉安装进程了事！)。

这样，一个支持cancel的自定义UI的安装控制程序就OK了(demo哈)。如果要安装多个msi只需在Install方法中循环就可以了。

总结一下，通过调用几个windows API，我们可以实现对msi安装过程的控制。这比调用msiexec.exe更灵活，也为程序日后添加新的功能打下了基础。

转载：http://www.cnblogs.com/powertoolsteam/p/5316042.html

相关文章