添加代码示例springboot-restful

README.md

@@ -15,30 +15,32 @@ Spring Boot 现在已经成为Java 开发领域的一颗璀璨明珠，它本身
 
 每个项目一篇博客文章的详细讲解，点击链接可以查看文章：
 
-* springboot-thymeleaf [集成Thymeleaf构建Web应用](https://www.xncoding.com/2017/07/01/spring/sb-thymeleaf.html)
+项目名称                    | 文章地址
-* springboot-mybatis [集成MyBatis](https://www.xncoding.com/2017/07/02/spring/sb-mybatis.html)
+----------------------------|------------------------------------------------------------------------------------------
-* springboot-hibernate [集成Hibernate](https://www.xncoding.com/2017/07/03/spring/sb-hibernate.html)
+springboot-thymeleaf        | [集成Thymeleaf构建Web应用](https://www.xncoding.com/2017/07/01/spring/sb-thymeleaf.html)
-* springboot-mongodb [集成MongoDB](https://www.xncoding.com/2017/07/04/spring/sb-mongodb.html)
+springboot-mybatis          | [集成MyBatis](https://www.xncoding.com/2017/07/02/spring/sb-mybatis.html)
-* springboot-restful [实现RESTful接口](https://www.xncoding.com/2017/07/05/spring/sb-restful.html)
+springboot-hibernate        | [集成Hibernate](https://www.xncoding.com/2017/07/03/spring/sb-hibernate.html)
-* springboot-resttemplate [使用RestTemplate](https://www.xncoding.com/2017/07/06/spring/sb-restclient.html)
+springboot-mongodb          | [集成MongoDB](https://www.xncoding.com/2017/07/04/spring/sb-mongodb.html)
-* springboot-shiro [集成Shiro权限管理](https://www.xncoding.com/2017/07/07/spring/sb-shiro.html)
+springboot-restful          | [实现RESTful接口](https://www.xncoding.com/2017/07/05/spring/sb-restful.html)
-* springboot-swagger2 [集成Swagger2](https://www.xncoding.com/2017/07/08/spring/sb-swagger2.html)
+springboot-resttemplate     | [使用RestTemplate](https://www.xncoding.com/2017/07/06/spring/sb-restclient.html)
-* springboot-jwt [集成JWT实现接口权限认证](https://www.xncoding.com/2017/07/09/spring/sb-jwt.html)
+springboot-shiro            | [集成Shiro权限管理](https://www.xncoding.com/2017/07/07/spring/sb-shiro.html)
-* springboot-multisource[多数据源配置](https://www.xncoding.com/2017/07/10/spring/sb-multisource.html)
+springboot-swagger2         | [集成Swagger2](https://www.xncoding.com/2017/07/08/spring/sb-swagger2.html)
-* springboot-schedule [定时任务](https://www.xncoding.com/2017/07/12/spring/sb-schedule.html)
+springboot-jwt              | [集成JWT实现接口权限认证](https://www.xncoding.com/2017/07/09/spring/sb-jwt.html)
-* springboot-websocket [使用WebScoket实时通信](https://www.xncoding.com/2017/07/15/spring/sb-websocket.html)
+springboot-multisource      | [多数据源配置](https://www.xncoding.com/2017/07/10/spring/sb-multisource.html)
-* springboot-socketio [集成SocketIO实时通信](https://www.xncoding.com/2017/07/16/spring/sb-socketio.html)
+springboot-schedule         | [定时任务](https://www.xncoding.com/2017/07/12/spring/sb-schedule.html)
-* springboot-async [异步线程池](https://www.xncoding.com/2017/07/20/spring/sb-async.html)
+springboot-websocket        | [使用WebScoket实时通信](https://www.xncoding.com/2017/07/15/spring/sb-websocket.html)
-* springboot-starter [教你自己写starter](https://www.xncoding.com/2017/07/22/spring/sb-starter.html)
+springboot-socketio         | [集成SocketIO实时通信](https://www.xncoding.com/2017/07/16/spring/sb-socketio.html)
-* springboot-aop [使用AOP](https://www.xncoding.com/2017/07/24/spring/sb-aop.html)
+springboot-async            | [异步线程池](https://www.xncoding.com/2017/07/20/spring/sb-async.html)
-* springboot-transaction [声明式事务](https://www.xncoding.com/2017/07/26/spring/sb-transaction.html)
+springboot-starter          | [教你自己写starter](https://www.xncoding.com/2017/07/22/spring/sb-starter.html)
-* springboot-cache [使用缓存](https://www.xncoding.com/2017/07/28/spring/sb-cache.html)
+springboot-aop              | [使用AOP](https://www.xncoding.com/2017/07/24/spring/sb-aop.html)
-* springboot-redis [Redis数据库](https://www.xncoding.com/2017/07/30/spring/sb-redis.html)
+springboot-transaction      | [声明式事务](https://www.xncoding.com/2017/07/26/spring/sb-transaction.html)
-* springboot-batch [批处理](https://www.xncoding.com/2017/08/01/spring/sb-batch.html)
+springboot-cache            | [使用缓存](https://www.xncoding.com/2017/07/28/spring/sb-cache.html)
-* springboot-rabbitmq [集成消息队列RabbitMQ](https://www.xncoding.com/2017/08/06/spring/sb-rabbitmq.html)
+springboot-redis            | [Redis数据库](https://www.xncoding.com/2017/07/30/spring/sb-redis.html)
-* springboot-echarts [集成Echarts导出图片](https://www.xncoding.com/2017/08/19/spring/sb-echarts.html)
+springboot-batch            | [批处理](https://www.xncoding.com/2017/08/01/spring/sb-batch.html)
-* app-manage [一个完整的Web后台管理系统，组合使用了多种技术]
+springboot-rabbitmq         | [集成消息队列RabbitMQ](https://www.xncoding.com/2017/08/06/spring/sb-rabbitmq.html)
-* app-manage-api [同时实现了需要认证授权访问的RESTful API接口和WebSocket接口]
+springboot-echarts          | [集成Echarts导出图片](https://www.xncoding.com/2017/08/19/spring/sb-echarts.html)
+app-manage                  | [一个完整的Web后台管理系统，组合使用了多种技术]
+app-manage-api              | [同时实现了需要认证授权访问的RESTful API接口和WebSocket接口]
 
 ## 环境
 

springboot-restful/.gitignore

@@ -0,0 +1,14 @@
+# 此为注释– 将被Git 忽略
+# /结尾表示是目录，忽略目录和目录下的所有件
+# /开头表示根目录，否则是.gitignore的相对目录
+# !开头表示反选
+.idea/
+target/
+*.iml
+*.ipr
+*.iws
+*.log
+.svn/
+.project
+rebel.xml
+.rebel-remote.xml.*

springboot-restful/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Xiong Neng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

springboot-restful/README.md

@@ -0,0 +1,9 @@
+## 实现RESTful API接口
+
+利用SpringMVC实现RESTful API接口
+
+## 许可证
+
+Copyright (c) 2018 Xiong Neng
+
+基于 MIT 协议发布: <http://www.opensource.org/licenses/MIT>

springboot-restful/pom.xml

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>com.xncoding</groupId>
+    <artifactId>springboot-restful</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+    <packaging>jar</packaging>
+
+    <name>springboot-restful</name>
+    <description>实现RESTful API接口</description>
+
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>1.5.9.RELEASE</version>
+        <relativePath/>
+    </parent>
+
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+        <java.version>1.8</java.version>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.springframework.boot</groupId>
+                    <artifactId>spring-boot-starter-tomcat</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-jetty</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.6.1</version>
+                <configuration>
+                    <!--<proc>none</proc>-->
+                    <source>1.8</source>
+                    <target>1.8</target>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.20</version>
+                <configuration>
+                    <skip>true</skip>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <executions>
+                </executions>
+            </plugin>
+        </plugins>
+
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+            </resource>
+            <resource>
+                <directory>src/main/java</directory>
+                <includes>
+                    <include>**/*.xml</include>
+                </includes>
+            </resource>
+        </resources>
+    </build>
+
+</project>

springboot-restful/run.sh

@@ -0,0 +1,72 @@
+#!/bin/bash
+# 项目自动更新脚本
+# 先clone相应的分支下来：
+# git clone ssh://git@120.24.173.142:7999/xxx.git
+# 远程调试启动：
+# nohup java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -Xms512m -Xmx1024m -jar -Dspring.profiles.active=${profile} ${jarfile} >/dev/null 2>&1 &
+
+function start {
+    profile="$1"
+    echo "启动环境profile=${profile}"
+    jarfile=$(ls target/*.jar)
+    if [[ "$?" == "0" ]]; then
+        stop $profile $jarfile
+    fi
+    branch=$(git branch |awk '{print $2}')
+    git pull origin ${branch}
+    echo "更新完代码开始重新打包"
+    mvn clean && mvn clean && mvn package -DskipTests=true
+    if [[ "$?" != "0" ]]; then
+        echo "编译出错，退出！"
+        exit 1
+    fi
+    echo "nohup java -Xms512m -Xmx1024m -jar -Dspring.profiles.active=${profile} ${jarfile} >/dev/null 2>&1 &"
+    nohup java -Xms512m -Xmx1024m -jar -Dspring.profiles.active=${profile} ${jarfile} >/dev/null 2>&1 &
+    echo "启动应用中，请查看日志文件..."
+}
+
+function stop {
+    profile="$1"
+    jarfile="$2"
+    ps aux | grep "${jarfile}" | grep "spring.profiles.active=${profile}" | grep -v grep > /dev/null
+    if [[ "$?" == "0" ]]; then
+        echo "该应用还在跑，我先停了它"
+        pid=$(ps aux | grep "${jarfile}" | grep "spring.profiles.active=${profile}" | grep -v grep |awk '{print $2}')
+        if [[ "$pid" != "" ]]; then
+            kill -9 $pid
+        fi
+        echo "停止应用成功..."
+    fi
+}
+
+if [[ "$1" == "start" ]]; then
+    if [[ "$#" < 2 ]]; then
+        echo "请输入正确参数：./epay.sh start {profile}"
+        exit 1
+    fi
+    profile="$2"
+    if [[ "$profile" != "dev" && "$profile" != "test" && "$profile" != "show" && "$profile" != "production" ]]; then
+        echo "参数错误，请输入正确的profile参数，使用方法："
+        echo "./epay.sh start {profile}    ==> 启动应用，{profile}取值：dev|test|show|production"
+        exit 1
+    fi
+    start "${profile}"
+elif [[ "$1" == "stop" ]]; then
+    if [[ "$#" < 2 ]]; then
+        echo "请输入正确参数：./epay.sh stop  {profile}"
+        exit 1
+    fi
+    profile="$2"
+    if [[ "$profile" != "dev" && "$profile" != "test" && "$profile" != "show" && "$profile" != "production" ]]; then
+        echo "参数错误，请输入正确的profile参数，使用方法："
+        echo "./epay.sh stop {profile}     ==> 停止应用，{profile}取值：dev|test|show|production"
+        exit 1
+    fi
+    jarfile=$(ls target/*.jar)
+    stop $profile $jarfile
+else
+    echo "参数错误，使用方法：{}参数是必填的，[]参数可选"
+    echo "./epay.sh start {profile}    ==> 启动应用，{profile}取值：dev|test|show|production"
+    echo "./epay.sh stop  {profile}    ==> 停止应用，{profile}取值：dev|test|show|production"
+    exit 1
+fi

springboot-restful/src/main/java/com/xncoding/pos/Application.java

@@ -0,0 +1,12 @@
+package com.xncoding.pos;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class Application {
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+
+}

springboot-restful/src/main/java/com/xncoding/pos/controller/LoginController.java

@@ -0,0 +1,40 @@
+package com.xncoding.pos.controller;
+
+import com.xncoding.pos.model.LoginParam;
+import com.xncoding.pos.model.UnbindParam;
+import com.xncoding.pos.model.BaseResponse;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * 登录接口类
+ */
+@RestController
+public class LoginController {
+
+    private static final Logger _logger = LoggerFactory.getLogger(LoginController.class);
+
+    @PostMapping("/login")
+    public BaseResponse<String> login(@RequestHeader(name = "Content-Type", defaultValue = "application/json") String contentType,
+                                      @RequestBody LoginParam loginParam) {
+        _logger.info("用户请求登录获取Token");
+        String username = loginParam.getUsername();
+        String password = loginParam.getPassword();
+        return new BaseResponse<>(true, "Login success", username + password);
+    }
+
+    @PostMapping("/unbind")
+    public BaseResponse<String> unbind(@RequestHeader(name = "Content-Type", defaultValue = "application/json") String contentType,
+                                       @RequestHeader(name = "Authorization", defaultValue = "token") String token,
+                                       @RequestBody UnbindParam unbindParam) {
+        _logger.info("解绑通知接口start");
+        String imei = unbindParam.getImei();
+        String location = unbindParam.getLocation();
+        return new BaseResponse<>(true, "解绑通知发送成功", "unbind");
+    }
+
+}

springboot-restful/src/main/java/com/xncoding/pos/model/BaseResponse.java

@@ -0,0 +1,60 @@
+package com.xncoding.pos.model;
+
+/**
+ * Controller的基础返回类
+ *
+ * @author XiongNeng
+ * @version 1.0
+ * @since 2018/1/7
+ */
+public class BaseResponse<T> {
+    /**
+     * 是否成功
+     */
+    private boolean success;
+
+    /**
+     * 说明
+     */
+    private String msg;
+
+    /**
+     * 返回数据
+     */
+    private T data;
+
+    public BaseResponse() {
+
+    }
+
+    public BaseResponse(boolean success, String msg, T data) {
+        this.success = success;
+        this.msg = msg;
+        this.data = data;
+    }
+
+    public boolean isSuccess() {
+        return success;
+    }
+
+    public void setSuccess(boolean success) {
+        this.success = success;
+    }
+
+    public String getMsg() {
+        return msg;
+    }
+
+    public void setMsg(String msg) {
+        this.msg = msg;
+    }
+
+    public T getData() {
+        return data;
+    }
+
+    public void setData(T data) {
+        this.data = data;
+    }
+
+}

springboot-restful/src/main/java/com/xncoding/pos/model/LoginParam.java

@@ -0,0 +1,59 @@
+package com.xncoding.pos.model;
+
+/**
+ * 登录认证接口参数
+ *
+ * @author XiongNeng
+ * @version 1.0
+ * @since 2018/1/9
+ */
+public class LoginParam {
+    /**
+     * 用户名
+     */
+    private String username;
+    /**
+     * 密码
+     */
+    private String password;
+    /**
+     * Application ID
+     */
+    private String appid;
+    /**
+     * IMEI码
+     */
+    private String imei;
+
+    public String getUsername() {
+        return username;
+    }
+
+    public void setUsername(String username) {
+        this.username = username;
+    }
+
+    public String getPassword() {
+        return password;
+    }
+
+    public void setPassword(String password) {
+        this.password = password;
+    }
+
+    public String getAppid() {
+        return appid;
+    }
+
+    public void setAppid(String appid) {
+        this.appid = appid;
+    }
+
+    public String getImei() {
+        return imei;
+    }
+
+    public void setImei(String imei) {
+        this.imei = imei;
+    }
+}

springboot-restful/src/main/java/com/xncoding/pos/model/UnbindParam.java

@@ -0,0 +1,35 @@
+package com.xncoding.pos.model;
+
+/**
+ * 解绑通知参数
+ *
+ * @author XiongNeng
+ * @version 1.0
+ * @since 2018/1/9
+ */
+public class UnbindParam {
+    /**
+     * IMEI码
+     */
+    private String imei;
+    /**
+     * 网点
+     */
+    private String location;
+
+    public String getImei() {
+        return imei;
+    }
+
+    public void setImei(String imei) {
+        this.imei = imei;
+    }
+
+    public String getLocation() {
+        return location;
+    }
+
+    public void setLocation(String location) {
+        this.location = location;
+    }
+}

springboot-restful/src/main/resources/application.yml

@@ -0,0 +1,46 @@
+##########################################################
+##################  所有profile共有的配置  #################
+##########################################################
+
+###################  项目启动端口  ###################
+server.port: 8092
+
+###################  spring配置  ###################
+spring:
+  profiles:
+    active: dev
+
+logging:
+  level:
+    org.springframework.web.servlet: ERROR
+
+---
+
+#####################################################################
+########################  开发环境profile  ##########################
+#####################################################################
+spring:
+  profiles: dev
+
+logging:
+  level:
+    ROOT: INFO
+    com:
+      xncoding: DEBUG
+  file: E:/logs/app.log
+
+---
+
+#####################################################################
+########################  测试环境profile  ##########################
+#####################################################################
+
+spring:
+  profiles: test
+
+logging:
+  level:
+    ROOT: INFO
+    com:
+      xncoding: DEBUG
+  file: /var/logs/app.log

springboot-restful/src/main/resources/banner.txt

@@ -0,0 +1,23 @@
+
+          _____           _______                   _____                    _____
+         /\    \         /::\    \                 /\    \                  /\    \
+        /::\____\       /::::\    \               /::\____\                /::\    \
+       /:::/    /      /::::::\    \             /:::/    /               /::::\    \
+      /:::/    /      /::::::::\    \           /:::/    /               /::::::\    \
+     /:::/    /      /:::/~~\:::\    \         /:::/    /               /:::/\:::\    \
+    /:::/    /      /:::/    \:::\    \       /:::/____/               /:::/__\:::\    \
+   /:::/    /      /:::/    / \:::\    \      |::|    |               /::::\   \:::\    \
+  /:::/    /      /:::/____/   \:::\____\     |::|    |     _____    /::::::\   \:::\    \
+ /:::/    /      |:::|    |     |:::|    |    |::|    |    /\    \  /:::/\:::\   \:::\    \
+/:::/____/       |:::|____|     |:::|    |    |::|    |   /::\____\/:::/__\:::\   \:::\____\
+\:::\    \        \:::\    \   /:::/    /     |::|    |  /:::/    /\:::\   \:::\   \::/    /
+ \:::\    \        \:::\    \ /:::/    /      |::|    | /:::/    /  \:::\   \:::\   \/____/
+  \:::\    \        \:::\    /:::/    /       |::|____|/:::/    /    \:::\   \:::\    \
+   \:::\    \        \:::\__/:::/    /        |:::::::::::/    /      \:::\   \:::\____\
+    \:::\    \        \::::::::/    /         \::::::::::/____/        \:::\   \::/    /
+     \:::\    \        \::::::/    /           ~~~~~~~~~~               \:::\   \/____/
+      \:::\    \        \::::/    /                                      \:::\    \
+       \:::\____\        \::/____/                                        \:::\____\
+        \::/    /         ~~                                               \::/    /
+         \/____/                                                            \/____/
+