SharpSevenZip is a 7-zip native library wrapper. Managed 7-zip library written in C# that provides data (self-)extraction and compression (all 7-zip formats are supported). Wraps 7z.dll or any compatible one and makes use of LZMA SDK, includes self-extraction functionality.
This is a fork from Squid-Box.SevenZipSharp which is a fork from tomap's fork of the original CodePlex project.
SevenZipSharp is an open source wrapper for 7-zip. It exploits the native 7zip dynamic link library through its COM interface and exports classes to work with various file archives. The project appeared as an improvement of http://www.codeproject.com/KB/DLL/cs_interface_7zip.aspx.
| Description | Value |
|---|---|
| License | https://github.com/JeremyAnsel/SharpSevenZip/blob/main/LICENSE |
| Documentation | http://jeremyansel.github.io/SharpSevenZip |
| Source code | https://github.com/JeremyAnsel/SharpSevenZip |
| Nuget | https://www.nuget.org/packages/SharpSevenZip |
| Build | https://ci.appveyor.com/project/JeremyAnsel/sharpsevenzip/branch/main |
As required by the GNU GPL 3.0 license, here's a rough list of what has changed since the original CodePlex project, including changes made in tomap's fork.
- Target .NET version changed from .NET Framework 2.0 to .NET Standard 2.0, .NET Framework 4.8, .NET 6.0 and .NET 8.0.
- Continous Integration added, both building and deploying.
- Tests re-written to NUnit 3 test cases.
- General code cleanup.
As well as a number of improvements and bug fixes.
SharpSevenZip exports three main classes - SharSevenZipExtractor, SharSevenZipCompressor and SharSevenZipSfx. SharSevenZipExtractor is a 7-zip unpacking front-end, it allows either to extract archives or LZMA-compressed byte arrays. SharSevenZipCompressor is a 7-zip pack ingfront-end, it allows either to compress archives or byte arrays. SharSevenZipSfx is a special class to create self-extracting archives. It uses the embedded sfx module by Oleg Scherbakov . LzmaEncodeStream/LzmaDecodeStream are special fully managed classes derived from Stream to store data compressed with LZMA and extract it.
SharpSevenZip requires a 7-zip native library to function. You can specify the path to a 7-zip dll (7z.dll, 7za.dll, etc.) in LibraryManager.cs at compile time, your app.config or via SetLibraryPath() method at runtime. + ("x86" or "x64") + "7z.dll" is the default path. For 64-bit systems, you must use the 64-bit versions of those libraries. 7-zip ships with 7z.dll, which is used for all archive operations (usually it is "Program Files\7-Zip\7z.dll"). 7za.dll is a light version of 7z.dll, it supports only 7zip archives. You may even build your own library with formats you want from 7-zip sources. SharpSevenZip will work with them all.
- Encryption and passwords are supported.
- Archive properties are supported.
- Multi-threading is supported.
- Streaming is supported.
- Setting the compression level and method is supported.
- Archive volumes are supported.
- Archive updates are supported.
- Extraction from SFX archives, as well as some other formats with embedded archives is supported.
Extraction is supported from any archive format in InArchiveFormat - such as 7-zip itself, zip, rar or cab and the format is automatically guessed by the archive signature. You can compress streams, files or whole directories in OutArchiveFormat - 7-zip, Xz, Zip, GZip, BZip2 and Tar. Please note that GZip and BZip2 compresses only one file at a time.
SharpSevenZipSfx supports custom sfx modules. The most powerful one is embedded in the assembly, the other lie in SharpSevenZip/sfx directory. Apart from usual sfx, you can make even small installations with the help of SfxSettings scenarios. Refer to the "configuration file parameters" for the complete command list.
SharpSevenZipCompressor.CustomParameters is a special property to set compression switches, compatible with command line switches of 7z.exe. The complete list of those switches is in 7-zip.chm of 7-Zip installation. For example, to turn on multi-threaded compression, code .CustomParameters.Add("mt", "on"); For the complete switches list, refer to SevenZipDoc.chm in the 7-zip installation.
Here is benchmarks to compare the performance of this library. The benchmarks use these libraries:
- .Net Framework with System.IO.Compression
- SharpCompress
- SevenZipSharp
- SharpSevenZip
| Method | Job | Mean | Error | Ratio | Allocated | Alloc Ratio |
|---|---|---|---|---|---|---|
| Decompress_DotNetFramework_Empty | Net80 | 3,042.1 us | NA | 5.24 | 51.3 KB | 0.92 |
| Decompress_DotNetFramework_Empty | Net60 | 1,639.6 us | NA | 2.82 | 51.55 KB | 0.92 |
| Decompress_DotNetFramework_Empty | Net48 | 580.6 us | NA | 1.00 | 56 KB | 1.00 |
| Decompress_SharpCompress_Empty | Net60 | 4,418.8 us | NA | 2.31 | 108.77 KB | 0.97 |
| Decompress_SharpCompress_Empty | Net80 | 3,866.2 us | NA | 2.02 | 107.89 KB | 0.96 |
| Decompress_SharpCompress_Empty | Net48 | 1,915.2 us | NA | 1.00 | 112 KB | 1.00 |
| Decompress_SevenZipSharp_Empty | Net80 | 12,933.3 us | NA | 1.98 | 1437.23 KB | 1.00 |
| Decompress_SevenZipSharp_Empty | Net60 | 10,845.9 us | NA | 1.66 | 1437.94 KB | 1.00 |
| Decompress_SevenZipSharp_Empty | Net48 | 6,547.6 us | NA | 1.00 | 1440.08 KB | 1.00 |
| Decompress_SharpSevenZip_Empty | Net80 | 5,289.0 us | NA | 2.61 | 72.64 KB | 1.01 |
| Decompress_SharpSevenZip_Empty | Net60 | 3,706.8 us | NA | 1.83 | 73.34 KB | 1.02 |
| Decompress_SharpSevenZip_Empty | Net48 | 2,026.9 us | NA | 1.00 | 72 KB | 1.00 |
| Decompress_DotNetFramework_Sum1 | Net80 | 5,806.9 us | NA | 2.33 | 59.75 KB | 0.07 |
| Decompress_DotNetFramework_Sum1 | Net60 | 3,958.1 us | NA | 1.59 | 59.84 KB | 0.07 |
| Decompress_DotNetFramework_Sum1 | Net48 | 2,497.1 us | NA | 1.00 | 864.47 KB | 1.00 |
| Decompress_SharpCompress_Sum1 | Net80 | 10,730.4 us | NA | 1.04 | 135.54 KB | 0.14 |
| Decompress_SharpCompress_Sum1 | Net60 | 10,606.4 us | NA | 1.03 | 137.45 KB | 0.15 |
| Decompress_SharpCompress_Sum1 | Net48 | 10,307.9 us | NA | 1.00 | 944.47 KB | 1.00 |
| Decompress_SevenZipSharp_Sum1 | Net60 | 31,525.8 us | NA | 1.32 | 28356.76 KB | 1.00 |
| Decompress_SevenZipSharp_Sum1 | Net80 | 30,917.0 us | NA | 1.30 | 28368.31 KB | 1.00 |
| Decompress_SevenZipSharp_Sum1 | Net48 | 23,795.4 us | NA | 1.00 | 28333.16 KB | 1.00 |
| Decompress_SharpSevenZip_Sum1 | Net80 | 14,997.3 us | NA | 1.55 | 105.06 KB | 0.02 |
| Decompress_SharpSevenZip_Sum1 | Net60 | 14,375.7 us | NA | 1.48 | 104.67 KB | 0.02 |
| Decompress_SharpSevenZip_Sum1 | Net48 | 9,690.2 us | NA | 1.00 | 6555.75 KB | 1.00 |
| Decompress_SharpSevenZip_Sum1_Stream | Net60 | 152,644.4 us | NA | 1.00 | 111.2 KB | 0.02 |
| Decompress_SharpSevenZip_Sum1_Stream | Net48 | 152,415.6 us | NA | 1.00 | 7380.22 KB | 1.00 |
| Decompress_SharpSevenZip_Sum1_Stream | Net80 | 150,575.1 us | NA | 0.99 | 111.59 KB | 0.02 |