Google Git
Sign in
apache / incubator-retired-gearpump-site / b1f8f45c651eb06f35685187224db1fb2c81a8de / . / releases / latest / dev-custom-serializer.html
blob: 27ba9c5c3bdc18f05536560f728947f6142456f2 [file] [log] [blame]
<!DOCTYPE html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1"/>
<title>Gearpump Customize Serializer - Gearpump 0.7.6 Documentation</title>
<link rel="stylesheet" href="css/bootstrap-3.3.5.min.css">
<style>
body {
padding-top: 60px;
padding-bottom: 40px;
}
</style>
<link rel="stylesheet" href="css/main.css">
<link rel="stylesheet" href="css/pygments-default.css">
<script src="js/vendor/modernizr-2.6.1-respond-1.1.0.min.js"></script>
</head>
<body>
<!--[if lt IE 7]>
<p class="chromeframe">You are using an outdated browser. <a href="http://browsehappy.com/">Upgrade your browser today</a> or <a href="http://www.google.com/chromeframe/?redirect=true">install Google Chrome Frame</a> to better experience this site.</p>
<![endif]-->
<div class="navbar navbar-inverse navbar-fixed-top" id="topbar">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="http://gearpump.io">Gearpump
<span class="label label-primary" style="font-size: .6em">0.7.6</span>
</a>
</div>
<div id="navbar" class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="index.html">Overview</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Introduction<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="submit-your-1st-application.html">Submit Your 1st Application</a></li>
<li><a href="commandline.html">Client Command Line</a></li>
<li class="divider"></li>
<li><a href="basic-concepts.html">Basic Concepts</a></li>
<li><a href="features.html">Technical Highlights</a></li>
<li><a href="message-delivery.html">Reliable Message Delivery</a></li>
<li><a href="performance-report.html">Performance</a></li>
<li><a href="gearpump-internals.html">Gearpump Internals</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Deploying<b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-header">Deployment</li>
<li><a href="deployment-local.html">Local Mode</a><li>
<li><a href="deployment-standalone.html">Standalone Mode</a></li>
<li><a href="deployment-yarn.html">YARN Mode</a></li>
<li><a href="deployment-docker.html">Docker Mode</a><li>
<li class="divider"></li>
<li><a href="deployment-ui-authentication.html">UI Authentication</a></li>
<li><a href="deployment-ha.html">High Availability</a></li>
<li><a href="deployment-msg-delivery.html">Reliable Message Delivery</a></li>
<li><a href="deployment-configuration.html">Configuration</a></li>
<li><a href="deployment-resource-isolation.html">Resource Isolation</a></li>
<li class="divider"></li>
<li><a href="deployment-security.html">YARN Security Guide</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Programming Guide<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="dev-write-1st-app.html">Write Your 1st App</a></li>
<li><a href="dev-custom-serializer.html">Customized Message Passing</a></li>
<li class="divider"></li>
<li><a href="api/scala/index.html">Scala API</a></li>
<li><a href="api/java/index.html">Java API</a></li>
<li><a href="dev-rest-api.html">RESTful API</a></li>
<li class="divider"></li>
<li><a href="dev-connectors.html">Gearpump Connectors</a></li>
<li class="divider"></li>
<li><a href="dev-storm.html">Storm Compatibility</a></li>
<!--
<li><a href="dev-samoa.html">Samoa Compatibility</a></li>
<li class="divider"></li>
<li><a href="dev-iot.html">Gearpump with IoT</a></li>
-->
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">More<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="how-to-contribute.html">How to Contribute</a></li>
<li><a href="coding-style.html">Coding Style</a></li>
<li class="divider"></li>
<li><a href="faq.html">FAQ</a><li>
<li><a href="about.html">About</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="container" id="content">
<h1 class="title">Gearpump Customize Serializer</h1>
<p>Gearpump has a built-in serialization framework with a shaded Kryo version, which allows you to customize how a specific message type can be serialized.</p>
<h4 id="register-a-class-before-serialization">Register a class before serialization.</h4>
<p>Note, to use built-in kryo serialization framework, Gearpump requires all classes to be registered explicitly before using, no matter you want to use a custom serializer or not. If not using custom serializer, Gearpump will use default com.esotericsoftware.kryo.serializers.FieldSerializer to serialize the class.</p>
<p>To register a class, you need to change the configuration file gear.conf(or application.conf if you want it only take effect for single application).</p>
<div class="highlight"><pre><code>gearpump {
serializers {
## We will use default FieldSerializer to serialize this class type
"io.gearpump.UserMessage" = ""
## we will use custom serializer to serialize this class type
"io.gearpump.UserMessage2" = "io.gearpump.UserMessageSerializer"
}
}
</code></pre></div>
<h4 id="how-to-define-a-custom-serializer-for-built-in-kryo-serialization-framework">How to define a custom serializer for built-in kryo serialization framework</h4>
<p>When you decide that you want to define a custom serializer, you can do this in two ways.</p>
<p>Please note that Gearpump shaded the original Kryo dependency. The package name <code>com.esotericsoftware</code> was relocated to <code>io.gearpump.esotericsoftware</code>. So in the following customization, you should import corresponding shaded classes, the example code will show that part.</p>
<h5 id="system-level-serializer">System Level Serializer</h5>
<p>If the serializer is widely used, you can define a global serializer which is available to all applications(or worker or master) in the system.</p>
<h6 id="step1-you-first-need-to-develop-a-java-library-which-contains-the-custom-serializer-class-here-is-an-example">Step1: you first need to develop a java library which contains the custom serializer class. here is an example:</h6>
<div class="highlight"><pre><code class="language-scala"><span class="k">package</span> <span class="nn">io.gearpump</span>
<span class="k">import</span> <span class="nn">io.gearpump.esotericsoftware.kryo.</span><span class="o">{</span><span class="nc">Kryo</span><span class="o">,</span> <span class="nc">Serializer</span><span class="o">}</span>
<span class="k">import</span> <span class="nn">io.gearpump.esotericsoftware.kryo.io.</span><span class="o">{</span><span class="nc">Input</span><span class="o">,</span> <span class="nc">Output</span><span class="o">}</span>
<span class="k">class</span> <span class="nc">UserMessage</span><span class="o">(</span><span class="n">longField</span><span class="k">:</span> <span class="kt">Long</span><span class="o">,</span> <span class="n">intField</span><span class="k">:</span> <span class="kt">Int</span><span class="o">)</span>
<span class="k">class</span> <span class="nc">UserMessageSerializer</span> <span class="k">extends</span> <span class="nc">Serializer</span><span class="o">[</span><span class="kt">UserMessage</span><span class="o">]</span> <span class="o">{</span>
<span class="k">override</span> <span class="k">def</span> <span class="n">write</span><span class="o">(</span><span class="n">kryo</span><span class="k">:</span> <span class="kt">Kryo</span><span class="o">,</span> <span class="n">output</span><span class="k">:</span> <span class="kt">Output</span><span class="o">,</span> <span class="n">obj</span><span class="k">:</span> <span class="kt">UserMessage</span><span class="o">)</span> <span class="k">=</span> <span class="o">{</span>
<span class="n">output</span><span class="o">.</span><span class="n">writeLong</span><span class="o">(</span><span class="n">obj</span><span class="o">.</span><span class="n">longField</span><span class="o">)</span>
<span class="n">output</span><span class="o">.</span><span class="n">writeInt</span><span class="o">(</span><span class="n">obj</span><span class="o">.</span><span class="n">intField</span><span class="o">)</span>
<span class="o">}</span>
<span class="k">override</span> <span class="k">def</span> <span class="n">read</span><span class="o">(</span><span class="n">kryo</span><span class="k">:</span> <span class="kt">Kryo</span><span class="o">,</span> <span class="n">input</span><span class="k">:</span> <span class="kt">Input</span><span class="o">,</span> <span class="n">typ</span><span class="k">:</span> <span class="kt">Class</span><span class="o">[</span><span class="kt">UserMessage</span><span class="o">])</span><span class="k">:</span> <span class="kt">UserMessage</span> <span class="o">=</span> <span class="o">{</span>
<span class="k">val</span> <span class="n">longField</span> <span class="k">=</span> <span class="n">input</span><span class="o">.</span><span class="n">readLong</span><span class="o">()</span>
<span class="k">val</span> <span class="n">intField</span> <span class="k">=</span> <span class="n">input</span><span class="o">.</span><span class="n">readInt</span><span class="o">()</span>
<span class="k">new</span> <span class="nc">UserMessage</span><span class="o">(</span><span class="n">longField</span><span class="o">,</span> <span class="n">intField</span><span class="o">)</span>
<span class="o">}</span>
<span class="o">}</span></code></pre></div>
<h6 id="step2-distribute-the-libraries">Step2: Distribute the libraries</h6>
<p>Distribute the jar file to lib/ folder of every Gearpump installation in the cluster.</p>
<h6 id="step3-change-gearconf-on-every-machine-of-the-cluster">Step3: change gear.conf on every machine of the cluster:</h6>
<div class="highlight"><pre><code>gearpump {
serializers {
"io.gearpump.UserMessage" = "io.gearpump.UserMessageSerializer"
}
}
</code></pre></div>
<h6 id="all-set">All set!</h6>
<h5 id="define-application-level-custom-serializer">Define Application level custom serializer</h5>
<p>If all you want is to define an application level serializer, which is only visible to current application AppMaster and Executors(including tasks), you can follow a different approach.</p>
<h6 id="step1-define-your-custom-serializer-class">Step1: Define your custom Serializer class</h6>
<p>You should include the Serializer class in your application jar. Here is an example to define a custom serializer:</p>
<div class="highlight"><pre><code class="language-scala"><span class="k">package</span> <span class="nn">io.gearpump</span>
<span class="k">import</span> <span class="nn">io.gearpump.esotericsoftware.kryo.</span><span class="o">{</span><span class="nc">Kryo</span><span class="o">,</span> <span class="nc">Serializer</span><span class="o">}</span>
<span class="k">import</span> <span class="nn">io.gearpump.esotericsoftware.kryo.io.</span><span class="o">{</span><span class="nc">Input</span><span class="o">,</span> <span class="nc">Output</span><span class="o">}</span>
<span class="k">class</span> <span class="nc">UserMessage</span><span class="o">(</span><span class="n">longField</span><span class="k">:</span> <span class="kt">Long</span><span class="o">,</span> <span class="n">intField</span><span class="k">:</span> <span class="kt">Int</span><span class="o">)</span>
<span class="k">class</span> <span class="nc">UserMessageSerializer</span> <span class="k">extends</span> <span class="nc">Serializer</span><span class="o">[</span><span class="kt">UserMessage</span><span class="o">]</span> <span class="o">{</span>
<span class="k">override</span> <span class="k">def</span> <span class="n">write</span><span class="o">(</span><span class="n">kryo</span><span class="k">:</span> <span class="kt">Kryo</span><span class="o">,</span> <span class="n">output</span><span class="k">:</span> <span class="kt">Output</span><span class="o">,</span> <span class="n">obj</span><span class="k">:</span> <span class="kt">UserMessage</span><span class="o">)</span> <span class="k">=</span> <span class="o">{</span>
<span class="n">output</span><span class="o">.</span><span class="n">writeLong</span><span class="o">(</span><span class="n">obj</span><span class="o">.</span><span class="n">longField</span><span class="o">)</span>
<span class="n">output</span><span class="o">.</span><span class="n">writeInt</span><span class="o">(</span><span class="n">obj</span><span class="o">.</span><span class="n">intField</span><span class="o">)</span>
<span class="o">}</span>
<span class="k">override</span> <span class="k">def</span> <span class="n">read</span><span class="o">(</span><span class="n">kryo</span><span class="k">:</span> <span class="kt">Kryo</span><span class="o">,</span> <span class="n">input</span><span class="k">:</span> <span class="kt">Input</span><span class="o">,</span> <span class="n">typ</span><span class="k">:</span> <span class="kt">Class</span><span class="o">[</span><span class="kt">UserMessage</span><span class="o">])</span><span class="k">:</span> <span class="kt">UserMessage</span> <span class="o">=</span> <span class="o">{</span>
<span class="k">val</span> <span class="n">longField</span> <span class="k">=</span> <span class="n">input</span><span class="o">.</span><span class="n">readLong</span><span class="o">()</span>
<span class="k">val</span> <span class="n">intField</span> <span class="k">=</span> <span class="n">input</span><span class="o">.</span><span class="n">readInt</span><span class="o">()</span>
<span class="k">new</span> <span class="nc">UserMessage</span><span class="o">(</span><span class="n">longField</span><span class="o">,</span> <span class="n">intField</span><span class="o">)</span>
<span class="o">}</span>
<span class="o">}</span></code></pre></div>
<h6 id="step2-put-a-applicationconf-in-your-classpath-on-client-machine-where-you-submit-the-application">Step2: Put a application.conf in your classpath on Client machine where you submit the application,</h6>
<div class="highlight"><pre><code>### content of application.conf
gearpump {
serializers {
"io.gearpump.UserMessage" = "io.gearpump.UserMessageSerializer"
}
}
</code></pre></div>
<h6 id="step3-all-set">Step3: All set!</h6>
<h4 id="advanced-choose-another-serialization-framework">Advanced: Choose another serialization framework</h4>
<p>Note: This is only for advanced user which require deep customization of Gearpump platform.</p>
<p>There are other serialization framework besides Kryo, like Protobuf. If user don&#8217;t want to use the built-in kryo serialization framework, he can customize a new serialization framework.</p>
<p>basically, user need to define in gear.conf(or application.conf for single application&#8217;s scope) file like this:</p>
<div class="highlight"><pre><code class="language-bash">gearpump.serialization-framework <span class="o">=</span> <span class="s2">&quot;io.gearpump.serializer.CustomSerializationFramework&quot;</span></code></pre></div>
<p>Please find an example in gearpump storm module, search &#8220;StormSerializationFramework&#8221; in source code.</p>
</div> <!-- /container -->
<script src="js/vendor/jquery-2.1.4.min.js"></script>
<script src="js/vendor/bootstrap-3.3.5.min.js"></script>
<script src="js/vendor/anchor-1.1.1.min.js"></script>
<script src="js/main.js"></script>
<!-- MathJax Section -->
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
TeX: { equationNumbers: { autoNumber: "AMS" } }
});
</script>
<script>
// Note that we load MathJax this way to work with local file (file://), HTTP and HTTPS.
// We could use "//cdn.mathjax...", but that won't support "file://".
(function(d, script) {
script = d.createElement('script');
script.type = 'text/javascript';
script.async = true;
script.onload = function(){
MathJax.Hub.Config({
tex2jax: {
inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ],
displayMath: [ ["$$","$$"], ["\\[", "\\]"] ],
processEscapes: true,
skipTags: ['script', 'noscript', 'style', 'textarea', 'pre']
}
});
};
script.src = ('https:' == document.location.protocol ? 'https://' : 'http://') +
'cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML';
d.getElementsByTagName('head')[0].appendChild(script);
}(document));
</script>
</body>
</html>