用Gradle和SpringBoot实现简单的RESTful框架

完整GitHub代码

Spring Boot的目的是为了简化开发基于Spring框架的单体生产级系统，开发直接运行的Spring程序的框架；也可以理解为是一种简单的微服务框架。可以快速的开发基于Spring的Web应用，而且避免了复杂繁琐的XML配置。

文章中的例子，使用IDEA进行开发，Gradle作为包管理和自动化构建工具。

注意：执行过程中，如果有依赖包无法加载的问题，或者其他问题，多执行几次gradle build确保build可以正确通过。

第一步，在IDEA中创建一个Gradle项目

创建过程中，选择User auto-import其他的默认填写就可以，创建后以后默认就有一些文件和目录，以下是需要用到的。

• build.gradle  gradle构建的脚本，包管理和稍后的构建，都是在脚本中配置的。
• src/main  程序的主程序和配置文件。
• src/main/java 主程序
• src/main/resources 配置文件
• src/test  测试的主程序代码和配置文件，结构和主程序相通。

第二部，配置Gradle脚本

内容如下：

buildscript {
    repositories {
        mavenLocal()
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:1.2.7.RELEASE")
    }
}

group 'com.liuwill.demo'
version '1.0-SNAPSHOT'

apply plugin: 'java'
apply plugin: 'idea'
apply plugin: 'spring-boot'

sourceCompatibility = 1.8

repositories {
    mavenLocal()
    mavenCentral()
}

dependencies {
    // tag::jetty[]
    compile("org.springframework.boot:spring-boot-starter-web") {
        exclude module: "spring-boot-starter-tomcat"
    }
    compile("org.springframework.boot:spring-boot-starter-jetty")
    // end::jetty[]
    // tag::actuator[]
    compile("org.springframework.boot:spring-boot-starter-actuator")
    compile("org.springframework.boot:spring-boot-starter-aop")
    compile("org.springframework:spring-context-support")
    compile("org.springframework:spring-tx")
    compile "org.springframework:spring-jdbc"
    // end::actuator[]
    compile('org.freemarker:freemarker:2.3.23')
    compile 'mysql:mysql-connector-java:5.1.36'
    compile 'com.h2database:h2:1.4.189'
    compile 'org.apache.commons:commons-dbcp2:2.1'
    compile 'com.alibaba:fastjson:1.2.6'

    testCompile group: 'org.testng', name: 'testng', version: '6.9.8'
    testCompile 'com.jayway.jsonpath:json-path:2.0.0'
    testCompile("org.springframework.boot:spring-boot-starter-test")
    testCompile "org.springframework:spring-test"
}

test {
    useTestNG{
        suites 'src/test/resources/testng.xml'
        useDefaultListeners = true
    }
}

修改完之后点击Gradle Tool Window中的刷新按钮，会自动下载对应的依赖包。

第三步 创建Spring Boot的资源配置文件

在src/resources/config目录下创建文件application.properties，指定运行web服务的端口，还有一些之前放在xml中的配置项。

server.port=8080
local.server.port = 8080

#MySql Config
spring.datasource.url=jdbc:mysql://localhost/demodb
spring.datasource.username=demo
spring.datasource.password=0123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.initialize=false

第四步 创建Spring Boot的主类

主类中包含Main函数，是程序的挂载点，可以通过Java执行的方式，直接运行该类，就可以通过SpringBoot来编写Spring框架的应用。

package com.liuwill.demo.boot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
import java.util.Arrays;

@SpringBootApplication
public class DemoBootApplication {

    public static void main(String[] args) {
        ApplicationContext ctx = SpringApplication.run(DemoBootApplication.class, args);

        System.out.println("通过SpringBoot来注入依赖:");

        String[] beanNames = ctx.getBeanDefinitionNames();
        Arrays.sort(beanNames);
        for (String beanName : beanNames) {
            System.out.println(beanName);
        }
    }

}

第五步 通过注解和类的方式来进行SpringMVC配置

SpringBoot通过注解的方式来实现SpringMVC配置，代替复杂的XML文件，可以通过创建一系列不同的类，进行各种相应的配置，首先通过一个继承WebMvcConfigurerAdapter进行基础的配置，这里使用freemarker作为模版引擎。通过ComponentScan注解，可以配置要扫描bean的路径。

@Configuration
@EnableWebMvc
@EnableTransactionManagement
@EnableAutoConfiguration
@ComponentScan(basePackages = {
        "com.liuwill.demo.boot.controller","com.liuwill.demo.boot.dao"
})
public class MvcConfigurer extends WebMvcConfigurerAdapter {
    @Bean
    public ViewResolver viewResolver() {
        FreeMarkerViewResolver resolver = new FreeMarkerViewResolver();
        resolver.setCache(true);
        resolver.setPrefix("");
        resolver.setSuffix(".ftl");
        resolver.setContentType("text/html; charset=UTF-8");
        return resolver;
    }

    @Bean
    public FreeMarkerConfigurer freemarkerConfig() throws IOException, TemplateException {
        FreeMarkerConfigurationFactory factory = new FreeMarkerConfigurationFactory();
        factory.setTemplateLoaderPaths("classpath:templates", "src/main/resource/templates");
        factory.setDefaultEncoding("UTF-8");
        FreeMarkerConfigurer result = new FreeMarkerConfigurer();
        result.setConfiguration(factory.createConfiguration());
        return result;
    }
}

第六步 编写一个简单的控制器

到这里基本的Spring Boot代码已经编写好，通过@RestController注解实现一个控制器类就可以看到运行的效果，代码如下

@RestController
public class DemoController {
    @Autowired
    private DemoService demoService;

    @Autowired
    private DemoUserService demoCommonService;

    @RequestMapping("/demo")
    public Map index() {
        Map resultMap = new HashMap();
        resultMap.put("status","success");
        resultMap.put("content",demoService.getString());
        return resultMap;
    }

    @RequestMapping(value = "/mobile/{mobile:.+}", method = RequestMethod.GET)
    public Object getSingleLoanItem(@PathVariable("mobile") String mobile) {
        Map resultMap = new HashMap();
        resultMap.put("status","success");
        resultMap.put("content",demoCommonService.getUserByMobile(mobile));
        return resultMap;
    }
}

接下来运行Gradle命令，gradle bootRun或者gradle run，就可以运行SpringBoot，并且加载Spring MVC框架了。直接执行curl http://localhost:8080/demo或者在浏览器中打开对应链接，就可以看到效果。

此外，idea默认会使用windows自带的gbk编码，会出现中文乱码问题，要在file encoding中设置所有的编码都是utf8。