使用manifest管理应用程序的依赖文件

1. 写在前面的话

我们在开发应用程序时,一般会引入一些第三方库,通常情况下,我们是把这些第三方依赖文件放到应用程序所处目录,这样应用程序启动时就能正确找到相关依赖文件。但当依赖文件比较多,我们希望对依赖的文件进行归类,放置到不同的目录下以便管理,这个时候应用程序的manifest就派上用场了。

2. 并行程序集(Side-by-Side Assembly)

在介绍应用程序的manifest之前,需要了解一下并行程序集(Side-by-Side Assembly)。什么是并行程序集呢? 并行程序集是微软为了解决DLL Hell问题而提出的一种解决方案,它采用manifest文件扫描组件之间的依赖关系。其工作原理如下图所求:

简单说明一下,微软在未提出Side-by-Side Assembly之前,应用程序启动时按照一定的规则加载DLL。通常情况下,应用程序会采用动态链接方式共享一些操作系统提供的基础库文件,当Windows更新共享库且共享库不能向后兼容时(DLL自身并不能向后兼容,这种情况通常发生在DLL的内存布局发生了改变),那些依赖于老版本共享库的应用程序就不能正常工作了。为了解决这个问题,微软重写了DLL动态加载子系统,提出了并行程序集的解决方案,即允许多个版本的库共同存在,应用程序通过manifest描述自身所依赖的文件,SxS Manager再通过manifest按照一定的规则找到应用程序的依赖文件,使应用程序正确工作。

3. 程序集查找顺序

和DLL加载顺序类似,SxS Manager在查找应用程序的依赖程序集时也按照一定的规则进行查找。一般情况下,其查找规则如下,如果应用程序需要多语言支持,请参考这里

  1. Side-by-side searches the WinSxS folder.
  2. \\<appdir>\<assemblyname>.DLL
  3. \\<appdir>\<assemblyname>.manifest
  4. \\<appdir>\<assemblyname>\<assemblyname>.DLL
  5. \\<appdir>\<assemblyname>\<assemblyname>.manifest

SxS Manager首先查找共享程序集, 共享程序集通常在Windows下的WinSxS目录下。如果未找到则会在应用程序所处目录按照上面顺序查找相应的程序集名。

4. 应用程序manifest

上面已经讲并行程序集的工作原理和并行程序集的查找顺序,接下来说一下如何用manifest描述应用程序的依赖程序集以及如何将manifest嵌入到应用程序中
关于应用程序的manifest详细介绍请参考这里, 下面以应用程序SampleApp为例,其manifest为SampleApp.exe.manifest, 如下:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
  <assemblyIdentity type="win32" name="SampleApp" version="1.0.0.0" processorArchitecture="x86"/>
  <compatibility xmlns="urn:schemas-microsoft-com:compatibility.v1"> 
      <application> 
          <supportedOS Id="{e2011457-1546-43c5-a5fe-008deee3d3f0}"/> 
          <supportedOS Id="{35138b9a-5d96-4fbd-8e2d-a2440225f93a}"/>
          <supportedOS Id="{4a2f28e3-53b9-4441-ba9c-d69d4a4a6e38}"/>
          <supportedOS Id="{1f676c76-80e1-4239-95bb-83d0f6d0da78}"/>
          <supportedOS Id="{8e0f7a12-bfb3-4fe8-b9a5-48fd50a15a9a}"/> 
      </application> 
  </compatibility>
  <trustInfo xmlns="urn:schemas-microsoft-com:asm.v3">
    <security>
      <requestedPrivileges>
        <requestedExecutionLevel level='asInvoker' uiAccess='false' />
      </requestedPrivileges>
    </security>
  </trustInfo>
  <dependency>
    <dependentAssembly>
      <assemblyIdentity type="win32" name="SampleAssembly" version="1.0.0.0" processorArchitecture="x86"/>
    </dependentAssembly>
  </dependency>
</assembly>

这里重点关注dependency结点,该结点描述了应用程序SampleApp依赖于程序集SampleAssembly。更多关于Assembly Manifest的XML描述请参考这里

有了上面的manifest,应用程序启动时,为了让SxS Manager能够正确查找到依赖文件,还需要将SampleApp.exe.manifest嵌入到应用程序中,有两种方式可以嵌入:
方法一
如果采用Visual Studio构建应用程序,默认情况下,VS会将manifest嵌入到应用程序中。按下面方式设置应用程序的依赖程序集:

Properties > Configuration Properties > Linker > Manifest File > Additional Manifest Dependencies >
type='win32' name='SampleAssembly' version='1.0.0.0' processorArchitecture='x86'

也可以采用comment prama方式:

#pragma comment(linker, "\"/manifestdependency:type='win32' name='SampleAssembly' version='1.0.0.0' processorArchitecture='x86' \"")

设置好之后,重新编译、链接,生成SampleApp.exe。如果想知道上面依赖信息是否已经成功嵌入到SampleApp.exe中,也有两种方式查看:
1. 如果使用Visual Studio, 可以直接在Visual Studio中打开应用程序,如下:


2. 也可以使用SDK提供的工具mt.exe, 命令如下:

mt.exe -inputresource:SampleApp.exe;#1 -out:SampleApp.exe.manifest

注意这个地方的1是manifest的资源序号,默认情况下是1。关于mt.exe的更多命令可以执行mt.exe /?或参考这里

方法二
使用mt.exe工具嵌入,如果采用VS构建应用程序,使用这种方式需要先关闭VS默认嵌入manifest的行为:

Properties > Configuration Properties > Linker > Manifest File > Generate Manifest > No (/MANIFEST:NO)

然后在Properties > Configuration Properties > Build Events > Post Build Event中写入以下命令:

mt.exe -manifest SampleApp.exe.manifest -outputresource:$(OutDir)$(TargetName)$(TargetExt);#1

上面命令的前提是文件SampleApp.exe.manifest在你的工程目录下。重新编译,链接。想知道manifest是否成功写入SampleApp.exe中,同样可以采用上面说的两种方法进行验证。

5. 实例应用

再次回到我们面临问题,仍然以应用程序SampleApp.exe为例,假设SampleApp依赖libA.dll,而libA.dll又依赖于libB.dll。我们希望奖libA.dll和libB.dll放到目录SampleAssembly下,目录结构如下:

/AppDir
    |---SampleApp.exe
    |        |
    |---SampleAssembly
             |---SampleAssembly.manifest
             |---libA.dll
             |---libB.dll 

1. 按照第4小节所述的方法将Sample.exe.manifest嵌入到Sample.exe中
2. 在SampleApp.exe所处目录下新建一个目录,目录名同依赖程序集名(SampleAssembly)
3. 在SampleAssembly目录下,新建一个manifest文件,文件名同程序集名(SampleAssembly),其内容如下:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
    <assemblyIdentity type="win32" name="SampleAssembly" version="1.0.0.0" processorArchitecture="x86"/>
    <file name="libA.dll"/>
    <file name="libB.dll"/>
</assembly>

4. 将libA.dll, libB.dll放到SampleAssembly目录下
5. 运行SampleApp.exe,看是否能正常工作了呢

6. 更多参考

[1]. https://msdn.microsoft.com/en-us/library/windows/desktop/ff951640(v=vs.85).aspx
[2]. https://msdn.microsoft.com/en-us/library/windows/desktop/aa374224(v=vs.85).aspx
[3]. https://msdn.microsoft.com/en-us/library/windows/desktop/aa374219(v=vs.85).aspx
[4]. https://msdn.microsoft.com/en-us/library/windows/desktop/aa374191(v=vs.85).aspx
[5]. https://docs.microsoft.com/zh-cn/cpp/build/manifest-generation-in-visual-studio
[6]. https://docs.microsoft.com/zh-cn/cpp/build/how-to-embed-a-manifest-inside-a-c-cpp-application
[7]. https://docs.microsoft.com/zh-cn/cpp/build/reference/manifestdependency-specify-manifest-dependencies
[8]. https://en.wikipedia.org/wiki/DLL_Hell
[9]. https://msdn.microsoft.com/en-us/library/windows/desktop/aa375649(v=vs.85).aspx

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • 个人学习批处理的初衷来源于实际工作;在某个迭代版本有个BS(安卓手游模拟器)大需求,从而在测试过程中就重复涉及到...
    Luckykailiu阅读 4,660评论 0 11
  • 在职场中我们经常会碰到自己费劲了千辛万苦把任务完成了,结果领导却并不满意,接着又对工作提出了这样那样的要求,自己一...
    觞咏阅读 322评论 3 3
  • 高三的每一天我几乎都会问自己一个问题 未来要做什么 看到触目惊心的分数总会觉得人生无望 高考失利横跨半个中国从北到...
    悬崖云书阅读 279评论 10 0
  • 人性是什么? 人性,是对人之常情的体谅、认同;人性,是对人之通性的成全和尊重;人性,是物伤同类的恻隐和悲悯;人性,...
    灵山阅读 2,548评论 0 1