gobyexample/public/base64-encoding
2022-12-24 20:01:48 +01:00

245 lines
9.7 KiB
Plaintext
Generated

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Go by Example: Base64 Encoding</title>
<link rel=stylesheet href="site.css">
</head>
<script>
onkeydown = (e) => {
if (e.key == "ArrowLeft") {
window.location.href = 'sha256-hashes';
}
if (e.key == "ArrowRight") {
window.location.href = 'reading-files';
}
}
</script>
<body>
<div class="example" id="base64-encoding">
<h2><a href="./">Go by Example</a>: Base64 Encoding</h2>
<table>
<tr>
<td class="docs">
<p>Go provides built-in support for <a href="https://en.wikipedia.org/wiki/Base64">base64
encoding/decoding</a>.</p>
</td>
<td class="code empty leading">
</td>
</tr>
<tr>
<td class="docs">
</td>
<td class="code leading">
<a href="https://go.dev/play/p/yztzkirFEvv"><img title="Run code" src="play.png" class="run" /></a><img title="Copy code" src="clipboard.png" class="copy" />
<pre class="chroma"><span class="kn">package</span> <span class="nx">main</span>
</pre>
</td>
</tr>
<tr>
<td class="docs">
<p>This syntax imports the <code>encoding/base64</code> package with
the <code>b64</code> name instead of the default <code>base64</code>. It&rsquo;ll
save us some space below.</p>
</td>
<td class="code leading">
<pre class="chroma">
<span class="kn">import</span> <span class="p">(</span>
<span class="nx">b64</span> <span class="s">&#34;encoding/base64&#34;</span>
<span class="s">&#34;fmt&#34;</span>
<span class="p">)</span>
</pre>
</td>
</tr>
<tr>
<td class="docs">
</td>
<td class="code leading">
<pre class="chroma"><span class="kd">func</span> <span class="nf">main</span><span class="p">()</span> <span class="p">{</span>
</pre>
</td>
</tr>
<tr>
<td class="docs">
<p>Here&rsquo;s the <code>string</code> we&rsquo;ll encode/decode.</p>
</td>
<td class="code leading">
<pre class="chroma">
<span class="nx">data</span> <span class="o">:=</span> <span class="s">&#34;abc123!?$*&amp;()&#39;-=@~&#34;</span>
</pre>
</td>
</tr>
<tr>
<td class="docs">
<p>Go supports both standard and URL-compatible
base64. Here&rsquo;s how to encode using the standard
encoder. The encoder requires a <code>[]byte</code> so we
convert our <code>string</code> to that type.</p>
</td>
<td class="code leading">
<pre class="chroma">
<span class="nx">sEnc</span> <span class="o">:=</span> <span class="nx">b64</span><span class="p">.</span><span class="nx">StdEncoding</span><span class="p">.</span><span class="nf">EncodeToString</span><span class="p">([]</span><span class="nb">byte</span><span class="p">(</span><span class="nx">data</span><span class="p">))</span>
<span class="nx">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="nx">sEnc</span><span class="p">)</span>
</pre>
</td>
</tr>
<tr>
<td class="docs">
<p>Decoding may return an error, which you can check
if you don&rsquo;t already know the input to be
well-formed.</p>
</td>
<td class="code leading">
<pre class="chroma">
<span class="nx">sDec</span><span class="p">,</span> <span class="nx">_</span> <span class="o">:=</span> <span class="nx">b64</span><span class="p">.</span><span class="nx">StdEncoding</span><span class="p">.</span><span class="nf">DecodeString</span><span class="p">(</span><span class="nx">sEnc</span><span class="p">)</span>
<span class="nx">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="nb">string</span><span class="p">(</span><span class="nx">sDec</span><span class="p">))</span>
<span class="nx">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">()</span>
</pre>
</td>
</tr>
<tr>
<td class="docs">
<p>This encodes/decodes using a URL-compatible base64
format.</p>
</td>
<td class="code">
<pre class="chroma">
<span class="nx">uEnc</span> <span class="o">:=</span> <span class="nx">b64</span><span class="p">.</span><span class="nx">URLEncoding</span><span class="p">.</span><span class="nf">EncodeToString</span><span class="p">([]</span><span class="nb">byte</span><span class="p">(</span><span class="nx">data</span><span class="p">))</span>
<span class="nx">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="nx">uEnc</span><span class="p">)</span>
<span class="nx">uDec</span><span class="p">,</span> <span class="nx">_</span> <span class="o">:=</span> <span class="nx">b64</span><span class="p">.</span><span class="nx">URLEncoding</span><span class="p">.</span><span class="nf">DecodeString</span><span class="p">(</span><span class="nx">uEnc</span><span class="p">)</span>
<span class="nx">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="nb">string</span><span class="p">(</span><span class="nx">uDec</span><span class="p">))</span>
<span class="p">}</span>
</pre>
</td>
</tr>
</table>
<table>
<tr>
<td class="docs">
<p>The string encodes to slightly different values with the
standard and URL base64 encoders (trailing <code>+</code> vs <code>-</code>)
but they both decode to the original string as desired.</p>
</td>
<td class="code leading">
<pre class="chroma">
<span class="gp">$</span> go run base64-encoding.go
<span class="go">YWJjMTIzIT8kKiYoKSctPUB+
</span><span class="go">abc123!?$*&amp;()&#39;-=@~</span></pre>
</td>
</tr>
<tr>
<td class="docs">
</td>
<td class="code">
<pre class="chroma"><span class="go">YWJjMTIzIT8kKiYoKSctPUB-
</span><span class="go">abc123!?$*&amp;()&#39;-=@~</span></pre>
</td>
</tr>
</table>
<p class="next">
Next example: <a href="reading-files">Reading Files</a>.
</p>
<p class="footer">
<script>
window.onload = function() {
function styleAllTags(tag, style, value){
document.querySelectorAll(tag).forEach((tag) => {
tag.style[style] = value
})
}
var themeButton = document.getElementById('theme-button');
var body = document.getElementsByTagName('body')[0];
var lightText = "#ffffffeb";
var darkText = "#252519";
var lightBackground = "white";
var darkBackground = "#1a202c";
var lightCodeBackground = "#f0f0f0";
var darkCodeBackground = "#333333";
function activateTheme(theme) {
if (theme === 'dark') {
body.style.color = lightText;
body.style.backgroundColor = darkBackground;
styleAllTags('a', 'color', lightText)
styleAllTags('td.code', 'background', darkCodeBackground);
styleAllTags('td.code.empty', 'background', darkBackground)
} else {
body.style.color = darkText;
body.style.backgroundColor = lightBackground;
styleAllTags('a', 'color', darkText)
styleAllTags('td.code', 'background', lightCodeBackground)
styleAllTags('td.code.empty', 'background', lightBackground)
}
localStorage.setItem('theme', theme);
}
var currentTheme = localStorage.getItem('theme');
if (currentTheme === 'light' || currentTheme === 'dark') {
activateTheme(currentTheme);
} else {
activateTheme('light');
}
themeButton.onclick = function() {
var newTheme = localStorage.getItem('theme') === 'dark' ? 'light' : 'dark';
activateTheme(newTheme);
}
}
</script>
by <a href="https://markmcgranaghan.com">Mark McGranaghan</a> and <a href="https://eli.thegreenplace.net">Eli Bendersky</a> | <a href="https://github.com/mmcgrana/gobyexample">source</a> | <a href="https://github.com/mmcgrana/gobyexample#license">license</a> | <button id="theme-button">Toggle theme</button>
</p>
</div>
<script>
var codeLines = [];
codeLines.push('');codeLines.push('package main\u000A');codeLines.push('import (\u000A b64 \"encoding/base64\"\u000A \"fmt\"\u000A)\u000A');codeLines.push('func main() {\u000A');codeLines.push(' data :\u003D \"abc123!?$*\u0026()\'-\u003D@~\"\u000A');codeLines.push(' sEnc :\u003D b64.StdEncoding.EncodeToString([]byte(data))\u000A fmt.Println(sEnc)\u000A');codeLines.push(' sDec, _ :\u003D b64.StdEncoding.DecodeString(sEnc)\u000A fmt.Println(string(sDec))\u000A fmt.Println()\u000A');codeLines.push(' uEnc :\u003D b64.URLEncoding.EncodeToString([]byte(data))\u000A fmt.Println(uEnc)\u000A uDec, _ :\u003D b64.URLEncoding.DecodeString(uEnc)\u000A fmt.Println(string(uDec))\u000A}\u000A');codeLines.push('');codeLines.push('');
</script>
<script src="site.js" async></script>
</body>
</html>