詳解二維碼生成工廠
來源：本站原創(chuàng)|時間：2020-01-10|欄目：C#教程|點擊： 次
本次主要分享的是3個免費的二維碼接口的對接代碼和測試得出的注意點及區(qū)別，有更好處理方式多多交流，相互促進進步；最近在學習JavsScript的擴展TypeScript，感覺語法糖很甜，大部分與C#更為類似，可能都是微軟項目的原因吧，有興趣的朋友可以多多相互交流下；
以上是個人的看法，下面來正式分享今天的文章吧：
- Google的Api二維碼生成接口
- 2d-code的Api二維碼生成接口
- topscan的Api二維碼生成接口
- 使用面向對象+加載程序集創(chuàng)建對象合并以上接口封裝成二維碼生成工廠
下面一步一個腳印的來分享：
Google的Api二維碼生成接口
首先，這里給出Google接口文檔的鏈接qr_codes文檔，熱情的朋友馬上就會打開此鏈接吧，詳細看下里面的參數這就不做截圖了，大致通常用到的參數是：api地址，內容參數，生成圖片的高寬這3個參數，其他的幾個參數都采用默認的吧，不同需要大家可以更詳細的看下；其實第一次看到文檔里面的參數，感覺少了一些東西，比如怎么不能傳遞二維碼中間那個圖標的圖片地址和掃描二維碼過后怎么跳轉到我想重定向的url鏈接呢，帶著這個疑問我進行了多次的嘗試；下面給出自己嘗試的結果說明：
- 接口關鍵參數是:cht(固定值qr)，chl(內容參數)，chs(生成出來二維碼圖片尺寸，格式如：200x200，這里是xyz的x不是*)
- api接口只會生成一個二維碼的圖片流，如果需要把圖片保存到本地需要通過瀏覽器直接get訪問接口或者通過程序下載這個二維碼
- 內容參數如果傳遞文本信息，在生成出來的二維碼圖片中間不會顯示文本內容，只有用手機掃描二維碼才能在手機上顯示傳遞的文本信息
- 內容參數如果傳遞單純的http://格式的鏈接地址，那么手機掃描后會自動重定向到改http://鏈接地址上（這個掃描重定向可以用來做一些商品或者文章的查看）
- google接口暫未研究出此Logo圖標地址參數（希望有朋友研究出來后與我分享，謝謝）
- 由于api地址是國外的，調用接口響應不是那么快速
其次，上面是個人的一些總結，下面我們來看下封裝的請求接口方法和下載二維碼圖片方法：
#region 生成二維碼
/// <summary>
/// 生成二維碼
/// </summary>
/// <param name="content">展示內容（文本內容 或者 掃描后的跳轉http://格式的地址）</param>
/// <param name="savePath">保存二維碼的磁盤路徑(默認程序跟目錄+QRCode)</param>
/// <param name="logoUrl"> Logo圖標地址（格式：http://),(注：google接口暫未研究出此參數）</param>
/// <param name="apiUrl">接口地址(內置默認api地址)</param>
/// <param name="wAndh">寬度和高度（二維碼正方形的，高寬一至,默認200）</param>
/// <returns></returns>
public virtual string CreateQRCode(string content = null, string savePath = null, string logoUrl = null, string apiUrl = null, int? wAndh = null)
{
var qrName = string.Empty;
#region 參數初始化
ApiUrl = apiUrl ?? ApiUrl;
Content = content ?? Content;
SaveQRPath = savePath ?? SaveQRPath;
LogoUrl = logoUrl ?? LogoUrl;
WAndH = wAndh ?? WAndH;
#endregion
if (string.IsNullOrEmpty(ApiUrl)) { return qrName; }
ApiUrl = string.Format("{0}?cht=qr&chl={1}&chs={2}x{2}",
ApiUrl,
HttpUtility.UrlEncode(Content),
WAndH);
qrName = DownImg(ApiUrl, SaveQRPath, ImageFormat.Jpeg);
return qrName;
}
#endregion
下載二維碼圖片保存到程序根目錄：
#region 下載圖片
/// <summary>
/// 下載圖片
/// </summary>
/// <param name="url">圖片下載地址</param>
/// <param name="savePath">保存路徑默認：Img文件夾</param>
/// <param name="format">默認：Jpeg</param>
/// <returns>新圖片名稱</returns>
public virtual string DownImg(string url, string savePath = "QRCode", ImageFormat format = null)
{
var qrName = string.Empty;
try
{
format = format ?? ImageFormat.Jpeg;
HttpClient http = new HttpClient();
http.Timeout = new TimeSpan(0, 1, 0);
using (var stream = http.GetStreamAsync(url).Result)
{
if (!Directory.Exists(SaveQRPath)) { Directory.CreateDirectory(SaveQRPath); }
qrName = DateTime.Now.ToString("yyyyMMddHHmmssfff") + "." + format;
var path = Path.Combine(savePath, qrName);
using (Image img = Image.FromStream(stream))
{
img.Save(path, format);
}
}
}
catch (Exception ex)
{
qrName = string.Empty;
}
return qrName;
}
#endregion
上面兩個方法使用的是虛方法，因為我這里是吧google接口當做默認的二維碼生成器來使用，后面要講的另外兩個接口都是重寫與此；下載圖片的方法都是公用的，暫不需要重寫；這里需要提到的是調用api接口時有一個固定的參數cht=qr，這個參數表示采用QR方法生成二維碼，因為這個api接口還有生成圖標的功能，所以只想要生成二維碼這里就固定，更多的生成圖標功能不在本章分享中，謝謝。
2d-code的Api二維碼生成接口
首先，該接口需要通過他們官網注冊一個key，然后從后臺獲取到這個key后才能調用接口地址，當然注冊后有個功能是，凡是您通過api接口生成的二維碼，除了自己通過流下載，還能通過他們后臺一起下載所有生成的圖片，本人暫時沒有去關注是否生成量大了會收費哈哈，下面列舉下接口參數說明和測試得出的注意點：
- 接口關鍵參數是：key(注冊獲取)，text(文本參數)，url(掃描后重定向地址)，logo(Logo圖標地址)，size(二維碼正方形，高寬)
- 接口的文本參數只能傳遞文本，不能當做掃描后重定向的地址參數使用和Google等接口有點不一樣
- 掃描后重定向地址和Logo圖標地址都是可訪問的http://格式的地址鏈接
- Logo圖標地址，官方說不建議使用png格式，測試只有jpg成功（可能是測試不夠多這里只單純介紹我的結果）
- 生成速度比較快，而且還有一個藝術字的生成接口，挺不錯
- api接口只會生成一個二維碼的圖片流，如果需要把圖片保存到本地需要通過瀏覽器直接get訪問接口或者通過程序下載這個二維碼
其次，下面給出封裝的代碼，由于下載和上面介紹的代碼一樣是公用的這里就不做陳述：
public QR_2dCode()
{
ApiUrl = "http://www.2d-code.cn/2dcode/api.php";
}
#region 生成二維碼
/// <summary>
/// 生成二維碼
/// </summary>
/// <param name="content">展示內容（文本內容 或者 掃描后的跳轉http://格式的地址）</param>
/// <param name="savePath">保存二維碼的磁盤路徑(默認程序跟目錄+QRCode)</param>
/// <param name="logoUrl"> Logo圖標地址（格式：http://)，官方不建議使用png格式，測試只有jpg成功</param>
/// <param name="directUrl">掃描后重定向地址（http://）</param>
/// <param name="apiUrl">接口地址(內置默認api地址)</param>
/// <param name="wAndh">寬度和高度（二維碼正方形的，高寬一至,默認200）</param>
/// <returns></returns>
public override string CreateQRCode(string content = null, string savePath = null, string logoUrl = null, string apiUrl = null, int? wAndh = null)
{
var qrName = string.Empty;
#region 參數初始化
ApiUrl = apiUrl ?? ApiUrl;
Content = content ?? Content;
SaveQRPath = savePath ?? SaveQRPath;
LogoUrl = logoUrl ?? LogoUrl;
WAndH = wAndh ?? WAndH;
#endregion
if (string.IsNullOrEmpty(ApiUrl)) { return qrName; }
ApiUrl = string.Format("{0}?key=c_d800OBbu6hDzJtXPE2Yd02IMtmpuK9VdCqHe6vrtar4&text={1}&url={2}&logo={3}&size={4}",
ApiUrl,
HttpUtility.UrlEncode(Content.Contains("http") ? "" : Content),
HttpUtility.UrlEncode(Content),
HttpUtility.UrlEncode(LogoUrl),
WAndH);
qrName = DownImg(ApiUrl, SaveQRPath);
return qrName;
}
#endregion
topscan的Api二維碼生成接口
首先，該接口肯定是免費的，參數描述和google的差不多，不同處在于可以傳遞Logo圖標地址（當然可能我還沒發(fā)現google的可以傳遞logo的參數，故此朋友們可以忽略）；下面列舉下接口參數說明和測試得出的注意點：
- 接口關鍵參數是：text(內容參數)，logo(Logo圖標地址)，w(生成出來二維碼圖片尺寸，格式如：200x200，這里是xyz的x不是*)
- api接口只會生成一個二維碼的圖片流，如果需要把圖片保存到本地需要通過瀏覽器直接get訪問接口或者通過程序下載這個二維碼
- 內容參數如果傳遞文本信息，在生成出來的二維碼圖片中間不會顯示文本內容，只有用手機掃描二維碼才能在手機上顯示傳遞的文本信息
- 內容參數如果傳遞單純的http://格式的鏈接地址，那么手機掃描后會自動重定向到改http://鏈接地址上（這個掃描重定向可以用來做一些商品或者文章的查看）
- Logo圖標地址（格式：http://)，jpg,png測試通過
- 測試得出有時候請求生成二維碼不返回數據，有可能是我網路問題吧，正常生成二維碼的速度還是挺快
其次，下面給出封裝的代碼，由于下載和上面介紹的代碼一樣是公用的這里就不做陳述：
public QR_TopScan()
{
ApiUrl = "http://qr.topscan.com/api.php";
}
#region 生成二維碼
/// <summary>
/// 生成二維碼
/// </summary>
/// <param name="content">展示內容（文本內容 或者 掃描后的跳轉http://格式的地址）</param>
/// <param name="savePath">保存二維碼的磁盤路徑(默認程序跟目錄+QRCode)</param>
/// <param name="logoUrl"> Logo圖標地址（格式：http://)，jpg,png測試通過，測試得出有不能成功的，原因不知是否和地址有關</param>
/// <param name="apiUrl">接口地址(內置默認api地址)</param>
/// <param name="wAndh">寬度和高度（二維碼正方形的，高寬一至,默認200）</param>
/// <returns></returns>
public override string CreateQRCode(string content = null, string savePath = null, string logoUrl = null, string apiUrl = null, int? wAndh = null)
{
var qrName = string.Empty;
#region 參數初始化
ApiUrl = apiUrl ?? ApiUrl;
Content = content ?? Content;
SaveQRPath = savePath ?? SaveQRPath;
LogoUrl = logoUrl ?? LogoUrl;
WAndH = wAndh ?? WAndH;
#endregion
if (string.IsNullOrEmpty(ApiUrl)) { return qrName; }
ApiUrl = string.Format("{0}?text={1}&logo={2}&w={3}",
ApiUrl,
HttpUtility.UrlEncode(Content),
HttpUtility.UrlEncode(LogoUrl),
WAndH);
qrName = DownImg(ApiUrl, SaveQRPath);
return qrName;
}
#endregion
使用面向對象+加載程序集創(chuàng)建對象合并以上接口封裝成二維碼生成工廠
首先，分析上面3個接口的參數可以看出，都需要固定的參數：接口api，內容（文本或跳轉http地址），Logo圖片地址（google暫時除外），寬度和高度等這幾個參數，這樣一來咋們可以定義個統(tǒng)一參數類，來傳遞該參數信息，這里還要提下由于這幾個接口都是從別人接口獲取圖片流，如果想要吧圖片在執(zhí)行程序時候直接保存在我們的程序本地，都需要下載，所以又多一個參數： 保存二維碼的磁盤路徑，所以才有了一下公共的屬性：
#region 基礎配置信息 /// <summary> /// 接口地址（必填） /// </summary> protected string ApiUrl = "https://chart.googleapis.com/chart"; /// <summary> /// 展示內容（文本內容）,google文本參數直接傳遞http地址直接重定向 /// </summary> protected string Content = "http://www.cnblogs.com/wangrudong003/"; /// <summary> /// 保存二維碼的磁盤路徑(默認程序跟目錄+QRCode) /// </summary> protected string SaveQRPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "QRCode"); /// <summary> /// Logo圖片地址（http://） /// </summary> protected string LogoUrl = "http://a.hiphotos.baidu.com/baike/w%3D268%3Bg%3D0/sign=9a34e44d8bd4b31cf03c93bdbfed4042/2cf5e0fe9925bc318cb9fe965edf8db1ca1370dc.jpg"; /// <summary> /// 寬度和高度（二維碼正方形的，高寬一至,默認200） /// </summary> protected int WAndH = 200; #endregion
然后，這里我不想每個接口都手動new一次來創(chuàng)建對象，所以用了加載程序集的模塊的方式來創(chuàng)建所需要的對象，因此有了工廠類的入口：
/// <summary>
/// 二維碼生成工廠
/// </summary>
public class QRCodeReposity
{
public static BaseQRCode Current(QREmType qrEmType = QREmType.BaseQRCode)
{
var nspace = typeof(BaseQRCode);
var fullName = nspace.FullName;
var nowspace = fullName.Substring(0, fullName.LastIndexOf('.') + 1);
return Assembly.GetExecutingAssembly().CreateInstance(nowspace + qrEmType.ToString(), true) as BaseQRCode;
}
}
這里和之前的緩存工廠文章設計差不多，可以查閱下之前的分享篇，也多多點贊，謝謝；下面在給出說有的代碼如下：
/// <summary>
/// 工廠模塊定義
/// </summary>
public enum QREmType
{
/// <summary>
/// google接口
/// </summary>
BaseQRCode,
/// <summary>
/// 2d-code接口
/// </summary>
QR_2dCode,
/// <summary>
/// topscan接口
/// </summary>
QR_TopScan
}
/// <summary>
/// 二維碼生成工廠
/// </summary>
public class QRCodeReposity
{
public static BaseQRCode Current(QREmType qrEmType = QREmType.BaseQRCode)
{
var nspace = typeof(BaseQRCode);
var fullName = nspace.FullName;
var nowspace = fullName.Substring(0, fullName.LastIndexOf('.') + 1);
return Assembly.GetExecutingAssembly().CreateInstance(nowspace + qrEmType.ToString(), true) as BaseQRCode;
}
}
/// <summary>
/// 基類使用Google提供Api：https://developers.google.com/chart/infographics/docs/qr_codes ,由于是國外地址，相對來說有點慢
/// </summary>
public class BaseQRCode
{
#region 基礎配置信息
/// <summary>
/// 接口地址（必填）
/// </summary>
protected string ApiUrl = "https://chart.googleapis.com/chart";
/// <summary>
/// 展示內容（文本內容）,google文本參數直接傳遞http地址直接重定向
/// </summary>
protected string Content = "http://www.cnblogs.com/wangrudong003/";
/// <summary>
/// 保存二維碼的磁盤路徑(默認程序跟目錄+QRCode)
/// </summary>
protected string SaveQRPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "QRCode");
/// <summary>
/// Logo圖片地址（http://）
/// </summary>
protected string LogoUrl = "http://a.hiphotos.baidu.com/baike/w%3D268%3Bg%3D0/sign=9a34e44d8bd4b31cf03c93bdbfed4042/2cf5e0fe9925bc318cb9fe965edf8db1ca1370dc.jpg";
/// <summary>
/// 寬度和高度（二維碼正方形的，高寬一至,默認200）
/// </summary>
protected int WAndH = 200;
#endregion
#region 方法
#region 生成二維碼
/// <summary>
/// 生成二維碼
/// </summary>
/// <param name="content">展示內容（文本內容 或者 掃描后的跳轉http://格式的地址）</param>
/// <param name="savePath">保存二維碼的磁盤路徑(默認程序跟目錄+QRCode)</param>
/// <param name="logoUrl"> Logo圖標地址（格式：http://),(注：google接口暫未研究出此參數）</param>
/// <param name="apiUrl">接口地址(內置默認api地址)</param>
/// <param name="wAndh">寬度和高度（二維碼正方形的，高寬一至,默認200）</param>
/// <returns></returns>
public virtual string CreateQRCode(string content = null, string savePath = null, string logoUrl = null, string apiUrl = null, int? wAndh = null)
{
var qrName = string.Empty;
#region 參數初始化
ApiUrl = apiUrl ?? ApiUrl;
Content = content ?? Content;
SaveQRPath = savePath ?? SaveQRPath;
LogoUrl = logoUrl ?? LogoUrl;
WAndH = wAndh ?? WAndH;
#endregion
if (string.IsNullOrEmpty(ApiUrl)) { return qrName; }
ApiUrl = string.Format("{0}?cht=qr&chl={1}&chs={2}x{2}",
ApiUrl,
HttpUtility.UrlEncode(Content),
WAndH);
qrName = DownImg(ApiUrl, SaveQRPath, ImageFormat.Jpeg);
return qrName;
}
#endregion
#region 下載圖片
/// <summary>
/// 下載圖片
/// </summary>
/// <param name="url">圖片下載地址</param>
/// <param name="savePath">保存路徑默認：Img文件夾</param>
/// <param name="format">默認：Jpeg</param>
/// <returns>新圖片名稱</returns>
public virtual string DownImg(string url, string savePath = "QRCode", ImageFormat format = null)
{
var qrName = string.Empty;
try
{
format = format ?? ImageFormat.Jpeg;
HttpClient http = new HttpClient();
http.Timeout = new TimeSpan(0, 1, 0);
using (var stream = http.GetStreamAsync(url).Result)
{
if (!Directory.Exists(SaveQRPath)) { Directory.CreateDirectory(SaveQRPath); }
qrName = DateTime.Now.ToString("yyyyMMddHHmmssfff") + "." + format;
var path = Path.Combine(savePath, qrName);
using (Image img = Image.FromStream(stream))
{
img.Save(path, format);
}
}
}
catch (Exception ex)
{
qrName = string.Empty;
}
return qrName;
}
#endregion
#endregion
}
/// <summary>
/// 使用2d-code提供Api,需要去官網注冊獲取Key
/// </summary>
public class QR_2dCode : BaseQRCode
{
public QR_2dCode()
{
ApiUrl = "http://www.2d-code.cn/2dcode/api.php";
}
#region 生成二維碼
/// <summary>
/// 生成二維碼
/// </summary>
/// <param name="content">展示內容（文本內容 或者 掃描后的跳轉http://格式的地址）</param>
/// <param name="savePath">保存二維碼的磁盤路徑(默認程序跟目錄+QRCode)</param>
/// <param name="logoUrl"> Logo圖標地址（格式：http://)，官方不建議使用png格式，測試只有jpg成功</param>
/// <param name="directUrl">掃描后重定向地址（http://）</param>
/// <param name="apiUrl">接口地址(內置默認api地址)</param>
/// <param name="wAndh">寬度和高度（二維碼正方形的，高寬一至,默認200）</param>
/// <returns></returns>
public override string CreateQRCode(string content = null, string savePath = null, string logoUrl = null, string apiUrl = null, int? wAndh = null)
{
var qrName = string.Empty;
#region 參數初始化
ApiUrl = apiUrl ?? ApiUrl;
Content = content ?? Content;
SaveQRPath = savePath ?? SaveQRPath;
LogoUrl = logoUrl ?? LogoUrl;
WAndH = wAndh ?? WAndH;
#endregion
if (string.IsNullOrEmpty(ApiUrl)) { return qrName; }
ApiUrl = string.Format("{0}?key=c_d800OBbu6hDzJtXPE2Yd02IMtmpuK9VdCqHe6vrtar4&text={1}&url={2}&logo={3}&size={4}",
ApiUrl,
HttpUtility.UrlEncode(Content.Contains("http") ? "" : Content),
HttpUtility.UrlEncode(Content),
HttpUtility.UrlEncode(LogoUrl),
WAndH);
qrName = DownImg(ApiUrl, SaveQRPath);
return qrName;
}
#endregion
}
/// <summary>
/// 使用topscan提供Api
/// </summary>
public class QR_TopScan : BaseQRCode
{
public QR_TopScan()
{
ApiUrl = "http://qr.topscan.com/api.php";
}
#region 生成二維碼
/// <summary>
/// 生成二維碼
/// </summary>
/// <param name="content">展示內容（文本內容 或者 掃描后的跳轉http://格式的地址）</param>
/// <param name="savePath">保存二維碼的磁盤路徑(默認程序跟目錄+QRCode)</param>
/// <param name="logoUrl"> Logo圖標地址（格式：http://)，jpg,png測試通過，測試得出有不能成功的，原因不知是否和地址有關</param>
/// <param name="apiUrl">接口地址(內置默認api地址)</param>
/// <param name="wAndh">寬度和高度（二維碼正方形的，高寬一至,默認200）</param>
/// <returns></returns>
public override string CreateQRCode(string content = null, string savePath = null, string logoUrl = null, string apiUrl = null, int? wAndh = null)
{
var qrName = string.Empty;
#region 參數初始化
ApiUrl = apiUrl ?? ApiUrl;
Content = content ?? Content;
SaveQRPath = savePath ?? SaveQRPath;
LogoUrl = logoUrl ?? LogoUrl;
WAndH = wAndh ?? WAndH;
#endregion
if (string.IsNullOrEmpty(ApiUrl)) { return qrName; }
ApiUrl = string.Format("{0}?text={1}&logo={2}&w={3}",
ApiUrl,
HttpUtility.UrlEncode(Content),
HttpUtility.UrlEncode(LogoUrl),
WAndH);
qrName = DownImg(ApiUrl, SaveQRPath);
return qrName;
}
#endregion
}
本篇的分享內容在程序設計方面沒有太多，重點是分裝下這幾個接口和分享下接口的差異，方面朋友們可以拿來主義和正在對接二維碼生成的朋友做下交流，僅此而已；關鍵代碼的備注都在分享代碼里，有更好或者不清楚的地方歡迎留言，謝謝。
以上就是本文的全部內容，希望本文的內容對大家的學習或者工作能帶來一定的幫助，同時也希望多多支持我們！
您可能感興趣的文章
- 01-10C#一個簡單的定時小程序實現代碼
- 01-10C#動態(tài)創(chuàng)建Access數據庫及密碼的方法
- 01-10C#獲取網頁源代碼的方法
- 01-10C#中Socket通信用法實例詳解
- 01-10WPF實現類似360安全衛(wèi)士界面的程序源碼分享
- 01-1010個C#程序員經常用到的實用代碼片段
- 01-10基于C#實現簡單離線注冊碼生成與驗證
- 01-10C#身份證號碼驗證是否正確
- 01-10C#裝箱和拆箱原理詳解
- 01-10C#導出網站功能實例代碼講解
閱讀排行
本欄相關
- 01-10C#通過反射獲取當前工程中所有窗體并
- 01-10關于ASP網頁無法打開的解決方案
- 01-10WinForm限制窗體不能移到屏幕外的方法
- 01-10WinForm繪制圓角的方法
- 01-10C#實現txt定位指定行完整實例
- 01-10WinForm實現仿視頻 器左下角滾動新
- 01-10C#停止線程的方法
- 01-10C#實現清空回收站的方法
- 01-10C#通過重寫Panel改變邊框顏色與寬度的
- 01-10C#實現讀取注冊表監(jiān)控當前操作系統(tǒng)已
隨機閱讀
- 01-11ajax實現頁面的局部加載
- 01-10SublimeText編譯C開發(fā)環(huán)境設置
- 04-02jquery與jsp,用jquery
- 01-11Mac OSX 打開原生自帶讀寫NTFS功能(圖文
- 01-10C#中split用法實例總結
- 08-05DEDE織夢data目錄下的sessions文件夾有什
- 08-05織夢dedecms什么時候用欄目交叉功能？
- 01-10使用C語言求解撲克牌的順子及n個骰子
- 08-05dedecms(織夢)副欄目數量限制代碼修改
- 01-10delphi制作wav文件的方法