165 lines
13 KiB
HTML
165 lines
13 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-us">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<title>Redkale(红菜苔)--基于Java 8全新的微服务开源框架 - Redkale官网</title>
|
||
<meta name="keywords" content="Redkale,redkale,java,微服务,架构"/>
|
||
<meta name="description" content="Redkale(红菜苔)是基于Java 8全新的微服务开源框架"/>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
|
||
</head>
|
||
<body>
|
||
<section class="page-header">
|
||
<a href="index.html" class="project-name">Redkale</a>
|
||
<h2 class="project-tagline"></h2>
|
||
<a href="redkale.html" class="btn">Redkale 入门</a>
|
||
<a href="convert.html" class="btn">Convert 组件</a>
|
||
<a href="service.html" class="btn">Service 组件</a>
|
||
<a href="source.html" class="btn">Source 组件</a>
|
||
<a href="net.html" class="btn">Net 组件</a>
|
||
<a href="watch.html" class="btn">Watch 组件</a>
|
||
<a href="plugins.html" class="btn">Redkale 插件</a>
|
||
<a href="articles.html" class="btn">技术文章</a>
|
||
</section>
|
||
|
||
<section class="main-content">
|
||
<h3>Redkale 入门教程 01 -- Hello Word！(IntelliJ IDEA Maven版)</h3>
|
||
|
||
<p>
|
||
<a href="index.html" target="_blank">Redkale</a> 可以说是Java界最精简的框架，不到1M的jar包可以替代Tomcat、Spring/Spring Boot、Hibernate/MyBatis、JackJson/fastjson、Netty的集合，四两拨千斤。低调开源一年多，经过两次大的改善后终于达到让自己满意的地步。Redkale不仅仅提供简易的API，还附有很多不同于传统思维的设计思路。由于时间有限，一年多也没写入门教程，现在开始抽点时间写一些教程，希望能给想学Redkale的同学一点帮助。 废话不多说，下面进入正题。<br/>
|
||
</p>
|
||
|
||
<p>创建工程</p>
|
||
<p>
|
||
首先创建一个Maven项目。
|
||
</p>
|
||
<p style="text-align: center;"><img src="images/hello_21.png" alt=""/><img src="images/hello_22.png" alt=""/></p>
|
||
<p style="text-align: center;"><img src="images/hello_23.png" alt=""/><img src="images/hello_24.png" alt=""/></p>
|
||
<p>
|
||
创建完项目后会自动打开pom.xml文件， 按下Alt+Insert组合键添加redkale依赖。
|
||
</p>
|
||
<p style="text-align: center;"><img src="images/hello_25.png" alt=""/><img src="images/hello_26.png" alt=""/></p>
|
||
<p>
|
||
然后将redkale下的bin和conf文件夹（可以通过github或者maven里<a href="https://repo1.maven.org/maven2/org/redkale/redkale/1.9.5/redkale-1.9.5.tar.gz" target="_blank">redkale-1.9.5.tar.gz</a>解压得到）复制到工程的目录下。
|
||
</p>
|
||
<p style="text-align: center;"><img src="images/hello_27.png" alt=""/></p>
|
||
<p>
|
||
编写HelloService类。
|
||
</p>
|
||
<div class="highlight"><pre><span></span><span class="kn">package</span> <span class="n">com.redkale.examples.hello</span><span class="o">;</span>
|
||
|
||
<span class="kn">import</span> <span class="n">org.redkale.net.http.*</span><span class="o">;</span>
|
||
<span class="kn">import</span> <span class="n">org.redkale.service.Service</span><span class="o">;</span>
|
||
|
||
<span class="nd">@RestService</span><span class="o">(</span><span class="n">automapping</span> <span class="o">=</span> <span class="kc">true</span><span class="o">)</span>
|
||
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">HelloService</span> <span class="kd">implements</span> <span class="n">Service</span> <span class="o">{</span>
|
||
|
||
<span class="kd">public</span> <span class="n">String</span> <span class="nf">sayHello</span><span class="o">()</span> <span class="o">{</span>
|
||
<span class="k">return</span> <span class="s">"Hello World！"</span><span class="o">;</span>
|
||
<span class="o">}</span>
|
||
|
||
<span class="kd">public</span> <span class="n">String</span> <span class="nf">hi</span><span class="o">(</span><span class="n">String</span> <span class="n">name</span><span class="o">)</span> <span class="o">{</span>
|
||
<span class="k">return</span> <span class="s">"Hi, "</span> <span class="o">+</span> <span class="n">name</span> <span class="o">+</span> <span class="s">"！"</span><span class="o">;</span>
|
||
<span class="o">}</span>
|
||
<span class="o">}</span>
|
||
</pre></div>
|
||
<p style="text-align: center;"><img src="images/hello_28.png" alt=""/></p>
|
||
|
||
<p>
|
||
然后开始调试运行。
|
||
</p>
|
||
<p style="text-align: center;"><img src="images/hello_29.png" alt=""/></p>
|
||
<p style="text-align: center;"><img src="images/hello_30.png" alt=""/></p>
|
||
<p style="text-align: center;"><img src="images/hello_31.png" alt=""/></p>
|
||
<p style="text-align: center;"><img src="images/hello_32.png" alt=""/></p>
|
||
<p style="text-align: center;"><img src="images/hello_33.png" alt=""/></p>
|
||
<p>
|
||
在浏览器输入: http://127.0.0.1:6060/pipes/hello/say 可以看到结果：
|
||
</p>
|
||
<p style="text-align: center;"><img src="images/hello_34.png" alt=""/></p>
|
||
<p>
|
||
在浏览器输入: http://127.0.0.1:6060/pipes/hello/hi?name=Redkale 可以看到结果：
|
||
</p>
|
||
<p style="text-align: center;"><img src="images/hello_35.png" alt=""/></p>
|
||
<p>
|
||
访问地址的端口6060和前缀pipes是通过conf/application.xml文件进行配置：
|
||
</p>
|
||
<div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">application</span> <span class="na">port</span><span class="o">=</span><span class="s">"2121"</span><span class="p">></span>
|
||
|
||
<span class="c"><!-- 详细配置说明见： http://redkale.org/redkale.html#redkale_confxml --></span>
|
||
|
||
<span class="p"><</span><span class="nt">resources</span><span class="p">></span>
|
||
<span class="c"><!-- </span>
|
||
<span class="c"> <properties></span>
|
||
<span class="c"> <property name="system.property.convert.json.tiny" value="true"/></span>
|
||
<span class="c"> </properties></span>
|
||
<span class="c"> --></span>
|
||
<span class="p"></</span><span class="nt">resources</span><span class="p">></span>
|
||
|
||
<span class="p"><</span><span class="nt">server</span> <span class="na">protocol</span><span class="o">=</span><span class="s">"HTTP"</span> <span class="na">host</span><span class="o">=</span><span class="s">"0.0.0.0"</span> <span class="na">port</span><span class="o">=</span><span class="s">"6060"</span> <span class="na">root</span><span class="o">=</span><span class="s">"root"</span><span class="p">></span>
|
||
|
||
<span class="p"><</span><span class="nt">services</span> <span class="na">autoload</span><span class="o">=</span><span class="s">"true"</span><span class="p">/></span>
|
||
|
||
<span class="c"><!-- base指定的自定义HttpServlet子类必须标记@HttpUserType, 不设置base则视为没有当前用户信息设置 --></span>
|
||
<span class="p"><</span><span class="nt">rest</span> <span class="na">path</span><span class="o">=</span><span class="s">"/pipes"</span> <span class="na">autoload</span><span class="o">=</span><span class="s">"true"</span> <span class="p">/></span>
|
||
|
||
<span class="p"><</span><span class="nt">servlets</span> <span class="na">path</span><span class="o">=</span><span class="s">"/pipes"</span> <span class="na">autoload</span><span class="o">=</span><span class="s">"true"</span> <span class="p">/></span>
|
||
|
||
<span class="p"></</span><span class="nt">server</span><span class="p">></span>
|
||
|
||
<span class="p"></</span><span class="nt">application</span><span class="p">></span>
|
||
</pre></div>
|
||
|
||
<p>
|
||
至此，一个简单的Hello服务就开发和调试完成了。可以看出，代码简单很多，不需要太多配置、maven和其他依赖包。<br>
|
||
可能有人会疑惑: HelloServie为什么能分配到hello前缀？ sayHello为什么会映射到/pipes/hello/say 请求？ Redkale为了减少Annotation配置采取了一些默认值的策略， 在Redkale里， 一个Service视为一个模块或服务，所以需要有模块(服务)名的概念，用于服务管理和鉴权，通常需要通过@RestServie.name来指定模块名，没有指定则默认将Service类名的Service字样之前的字符串视为模块名，如HelloService和HelloServiceImpl都会采用hello作为模块名。方法名的默认值策略也是类似，将模块名字样之前的字符串作为方法名，如sayHello和sayHelloMe 都会用say作为默认值。参数名如果没有指定@RestParam.name会自动采用代码的变量名。 完全标记Rest注解的HelloService源码如下：
|
||
</p>
|
||
<div class="highlight"><pre><span></span><span class="kn">package</span> <span class="n">com.redkale.examples.hello</span><span class="o">;</span>
|
||
|
||
<span class="kn">import</span> <span class="n">org.redkale.net.http.*</span><span class="o">;</span>
|
||
<span class="kn">import</span> <span class="n">org.redkale.service.Service</span><span class="o">;</span>
|
||
|
||
<span class="nd">@RestService</span><span class="o">(</span><span class="n">name</span> <span class="o">=</span> <span class="s">"hello"</span><span class="o">)</span>
|
||
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">HelloService</span> <span class="kd">implements</span> <span class="n">Service</span> <span class="o">{</span>
|
||
|
||
<span class="nd">@RestMapping</span><span class="o">(</span><span class="n">name</span> <span class="o">=</span> <span class="s">"say"</span><span class="o">)</span>
|
||
<span class="kd">public</span> <span class="n">String</span> <span class="nf">sayHello</span><span class="o">()</span> <span class="o">{</span>
|
||
<span class="k">return</span> <span class="s">"Hello World！"</span><span class="o">;</span>
|
||
<span class="o">}</span>
|
||
|
||
<span class="nd">@RestMapping</span><span class="o">(</span><span class="n">name</span> <span class="o">=</span> <span class="s">"hi"</span><span class="o">)</span>
|
||
<span class="kd">public</span> <span class="n">String</span> <span class="nf">hi</span><span class="o">(</span><span class="nd">@RestParam</span><span class="o">(</span><span class="n">name</span> <span class="o">=</span> <span class="s">"name"</span><span class="o">)</span> <span class="n">String</span> <span class="n">name</span><span class="o">)</span> <span class="o">{</span>
|
||
<span class="k">return</span> <span class="s">"Hi, "</span> <span class="o">+</span> <span class="n">name</span> <span class="o">+</span> <span class="s">"！"</span><span class="o">;</span>
|
||
<span class="o">}</span>
|
||
|
||
<span class="o">}</span>
|
||
</pre></div>
|
||
<br/>
|
||
<p>
|
||
这段代码与上面那段是等价的。部署也很简单， 将项目编译后的jar和redkale-1.9.5.jar复制到lib下(也可通过修改pom.xml让maven来处理)，运行bin/start.bat 即可启动HTTP服务。
|
||
</p>
|
||
<p>
|
||
本工程源码可以在 <a href="https://github.com/redkale/redkale-examples/tree/master/redkale-helloword" target="_blank">https://github.com/redkale/redkale-examples/tree/master/redkale-helloword</a> 下载。
|
||
</p>
|
||
<p>
|
||
转载请注明出处：<a href="https://redkale.org/course01_helloidea.html" target="_blank">https://redkale.org/course01_helloidea.html</a>
|
||
</p>
|
||
|
||
<footer class="site-footer">
|
||
<span class="site-footer-owner"> 欢迎加入Redkale QQ群: 527523235</span>
|
||
</footer>
|
||
|
||
</section>
|
||
|
||
<script>
|
||
var _hmt = _hmt || [];
|
||
(function () {
|
||
var hm = document.createElement("script");
|
||
hm.src = "//hm.baidu.com/hm.js?b4e05d7de8b5f3401dd93e3c6b35ffa5";
|
||
var s = document.getElementsByTagName("script")[0];
|
||
s.parentNode.insertBefore(hm, s);
|
||
})();
|
||
</script>
|
||
</body>
|
||
</html>
|