python微服务框架tortues_SpringBoot快速搭建微服务框架详细教程

前言&＃xff1a;

SpringBoot是为了简化Spring应用的创建、运行、调试、部署等而出现的&＃xff0c;使用它可以做到专注于Spring应用的开发&＃xff0c;而无需过多关注XML的配置。

简单来说&＃xff0c;它提供了一堆依赖打包&＃xff0c;并已经按照使用习惯解决了依赖问题---习惯大于约定。

Spring Boot默认使用tomcat作为服务器&＃xff0c;使用logback提供日志记录。

Spring Boot的主要优点&＃xff1a;

为所有Spring开发者更快的入门

开箱即用&＃xff0c;提供各种默认配置来简化项目配置

内嵌式容器简化Web项目

没有冗余代码生成和XML配置的要求

技术栈&＃xff1a;

Java 8

Maven

Spring-boot

Mybatis

Redis

Lombok

Swagger2

Jenkins

SonarQuber

1、使用Maven构建项目

1.1 通过 SPRING INITIALIZR 工具生产基础项目

通过访问&＃xff1a;http://start.spring.io/ 快速创建Spring-boot 的服务框架。

初始化相应信息后&＃xff0c;下载压缩包。解压完成后&＃xff0c;用IDEA打开项目&＃xff0c;项目的目录结构&＃xff1a;

总体流程&＃xff1a;

选择构建工具Maven Project、Spring Boot版本1.3.2以及一些工程基本信息

点击Generate Project下载项目压缩包

解压项目包&＃xff0c;并用IDE以Maven项目导入&＃xff0c;以IntelliJ IDEA 14为例&＃xff1a;

菜单中选择File–>New–>Project from Existing Sources...

选择解压后的项目文件夹&＃xff0c;点击OK

点击Import project from external model并选择Maven&＃xff0c;点击Next到底为止。

若你的环境有多个版本的JDK&＃xff0c;注意到选择Java SDK的时候请选择Java 7以上的版本

1.2 导入Spring-boot 相关依赖

项目初始化时&＃xff0c;相关依赖如下&＃xff1a;

spring-boot-starters&＃xff1a;核心模块&＃xff0c;包括自动配置支持、日志和YAML

spring-boot-starter-test&＃xff1a;测试模块&＃xff0c;包括JUnit、Hamcrest、Mockito

spring-boot-devtools&＃xff1a;用于设置热部署

org.springframework.boot

spring-boot-starter

org.springframework.boot

spring-boot-starter-test

test

org.springframework.boot

spring-boot-devtools

true

这里我们需要引入Web模块&＃xff0c;需要添加&＃xff1a;

org.springframework.boot

spring-boot-starter-web

1.3 启动项目

添加首页控制层&＃xff1a;

&＃64;RestController

public class IndexController {

&＃64;RequestMapping("index")

public String index() {

return "hello world!";

}

}

运行DemoApplication中的main方法&＃xff0c;启动服务&＃xff1a;

服务启动后&＃xff0c; 访问 http://localhost:8080/index &＃xff0c;可以看到页面输出Hello world&＃xff01;。

2、整合Mybatis

2.1 项目依赖

引入连接mysql的必要依赖mysql-connector-java

引入整合MyBatis的核心依赖mybatis-spring-boot-starter

引入tk.mybatis 依赖&＃xff0c;实现对实体类的增删改查的代码

引入pagerhelper 依赖&＃xff0c;实现分页功能

org.mybatis.spring.boot

mybatis-spring-boot-starter

1.3.0

mysql

mysql-connector-java

5.1.43

tk.mybatis

mapper-spring-boot-starter

1.1.3

com.github.pagehelper

pagehelper-spring-boot-starter

1.1.2

2.2 项目配置

修改resources 下的application.properties文件&＃xff1a;

spring.datasource.url&＃61;jdbc:mysql://localhost:3306/test

spring.datasource.username&＃61;root

spring.datasource.password&＃61;root

spring.datasource.driver-class-name&＃61;com.mysql.jdbc.Driver

#实体类扫描包

mybatis.type-aliases-package&＃61;com.jaycekon.demo.model

#Mapper.xml文件扫描目录

mybatis.mapper-locations&＃61;classpath:mapper/*.xml

#驼峰命名

mybatis.configuration.mapUnderscoreToCamelCase&＃61;true

#tkmapper 工具类

mapper.mappers&＃61;com.Jaycekon.demo.util.MyMapper

mapper.not-empty&＃61;false

mapper.identity&＃61;MYSQL

pagehelper.helperDialect&＃61;mysql

pagehelper.reasonable&＃61;true

pagehelper.supportMethodsArguments&＃61;true

pagehelper.params&＃61;count&＃61;countSql

2.3 单元测试

创建实体类&＃xff0c;我们引入Lombok相关依赖&＃xff0c;用于避免数据Get Set方法的重复创建&＃xff1a;

org.projectlombok

lombok

1.16.18

provided

实体类最终的代码如下&＃xff1a;

&＃64;Data

&＃64;NoArgsConstructor

&＃64;AllArgsConstructor

&＃64;Accessors(chain &＃61; true)

public class User {

private int id;

private String username;

private String idCard;

private String phone;

private String password;

}

可以看出&＃xff0c;在添加了Lombok 之后&＃xff0c;我们的Java 实体类代码简洁了很多。

接下来&＃xff0c;我们需要创建UserMapper 数据库处理类。由于MyMapper 已经帮我们实现了基本的CRUD操作&＃xff0c;因此我们这里并不需要再重写操作&＃xff0c;我可以先一个根据用户名查找的方法&＃xff1a;

&＃64;Mapper

public interface UserMapper extends MyMapper {

&＃64;Select("select * from user where username&＃61;#{username}")

User selectByName(String username);

}

MyMapper 类位于util 目录下&＃xff1a;

public interface MyMapper extends Mapper, MySqlMapper {

}

这里需要注意&＃xff0c;MyMapper 与我们的实体类Mapper 不能放在同一个目录。

测试类&＃xff1a;

&＃64;RunWith(SpringRunner.class)

&＃64;SpringBootTest

&＃64;MapperScan("com.Jaycekon.demo.mapper")

public class UserMapperTest {

&＃64;Autowired

private UserMapper mapper;

&＃64;Test

public void testInset() {

User user &＃61; new User(1, "Jaycekon","1234","1234","123");

int i &＃61; mapper.insert(user);

Assert.assertNotEquals(0, i);

}

&＃64;Test

public void testSelect(){

User user &＃61; mapper.selectByName("Jaycekon");

Assert.assertNotEquals(null,user);

}

}

3、整合Redis

3.1 相关依赖

Spring Boot提供的数据访问框架Spring Data Redis基于Jedis。可以通过引入 spring-boot-starter-redis 来配置依赖关系。

org.springframework.boot

spring-boot-starter-redis

3.2 Redis 配置

1、Spring-boot 连接单机版Redis 的配置如下&＃xff1a;

# REDIS (RedisProperties)

# Redis数据库索引&＃xff08;默认为0&＃xff09;

spring.redis.database&＃61;0

# Redis服务器地址

spring.redis.host&＃61;localhost

# Redis服务器连接端口

spring.redis.port&＃61;6379

# Redis服务器连接密码&＃xff08;默认为空&＃xff09;

spring.redis.password&＃61;

# 连接池最大连接数&＃xff08;使用负值表示没有限制&＃xff09;

spring.redis.pool.max-active&＃61;8

# 连接池最大阻塞等待时间&＃xff08;使用负值表示没有限制&＃xff09;

spring.redis.pool.max-wait&＃61;-1

# 连接池中的最大空闲连接

spring.redis.pool.max-idle&＃61;8

# 连接池中的最小空闲连接

spring.redis.pool.min-idle&＃61;0

# 连接超时时间&＃xff08;毫秒&＃xff09;

spring.redis.timeout&＃61;0

2、Spriig-boot 连接Sentinel 哨兵集群配置&＃xff1a;

# REDIS (RedisProperties)

# Redis数据库索引&＃xff08;默认为0&＃xff09;

spring.redis.database&＃61;0

# Redis服务器地址

#spring.redis.host&＃61;localhost

# Redis服务器连接端口

#spring.redis.port&＃61;6379

# Redis服务器连接密码&＃xff08;默认为空&＃xff09;

spring.redis.password&＃61;

# 连接池最大连接数&＃xff08;使用负值表示没有限制&＃xff09;

spring.redis.pool.max-active&＃61;8

# 连接池最大阻塞等待时间&＃xff08;使用负值表示没有限制&＃xff09;

spring.redis.pool.max-wait&＃61;-1

# 连接池中的最大空闲连接

spring.redis.pool.max-idle&＃61;8

# 连接池中的最小空闲连接

spring.redis.pool.min-idle&＃61;0

# 连接超时时间&＃xff08;毫秒&＃xff09;

spring.redis.timeout&＃61;0

#哨兵监听redis server名称

spring.redis.sentinel.master&＃61;cn-test-master

#哨兵的配置列表

spring.redis.sentinel.nodes&＃61;localhost:26379,localhost:36379,localhost:46379

3.3 Redis 操作工具类

1、StringRedisTemplate 工具类

StringRedisTemplate 工具类可以解决字符串级别的Redis操作。在写好配置后&＃xff0c;可以直接通过Autowried 就可以注入对象。

&＃64;RunWith(SpringJUnit4ClassRunner.class)

&＃64;SpringApplicationConfiguration(Application.class)

public class ApplicationTests {

&＃64;Autowired

private StringRedisTemplate stringRedisTemplate;

&＃64;Test

public void test() throws Exception {

// 保存字符串

stringRedisTemplate.opsForValue().set("aaa", "111");

Assert.assertEquals("111", stringRedisTemplate.opsForValue().get("aaa"));

}

}

2、RedisTemplate 工具类

可以处理大部分的序列化操作&＃xff0c;在这里我封装了一个简化Redis工具类&＃xff0c;后续可以继续优化。

&＃64;Component

public class RedisComponent {

&＃64;Autowired

//操作字符串的template&＃xff0c;StringRedisTemplate是RedisTemplate的一个子集

private StringRedisTemplate stringRedisTemplate;

private Logger logger &＃61; LoggerFactory.getLogger(RedisComponent.class);

&＃64;Autowired

// RedisTemplate&＃xff0c;可以进行所有的操作

private RedisTemplate redisTemplate;

public void set(String key, String value) {

ValueOperations ops &＃61; this.stringRedisTemplate.opsForValue();

boolean bExistent &＃61; this.stringRedisTemplate.hasKey(key);

if (bExistent) {

logger.info("this key is bExistent!");

} else {

ops.set(key, value);

}

}

public String get(String key) {

return this.stringRedisTemplate.opsForValue().get(key);

}

public void del(String key) {

this.stringRedisTemplate.delete(key);

}

public void sentinelSet(String key, Object object) {

redisTemplate.opsForValue().set(key, JSON.toJSONString(object));

}

public String sentinelGet(String key) {

return String.valueOf(redisTemplate.opsForValue().get(key));

}

}

4、整合Swagger2

4.1 添加Swagger2 依赖&＃xff1a;

io.springfox

springfox-swagger2

2.7.0

io.springfox

springfox-swagger-ui

2.7.0

4.2 创建Swagger2 配置类&＃xff1a;

在Application.java 同级创建一个Swagger2 的配置类&＃xff1a;

&＃64;Configuration

&＃64;EnableSwagger2

public class Swagger2 {

&＃64;Bean

public Docket webApi() {

return new Docket(DocumentationType.SWAGGER_2)

.groupName("DemoAPI接口文档")

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage("com.Jaycekon.demo.controller"))

.paths(PathSelectors.any()).build();

}

/**

swagger2使用说明&＃xff1a;

&＃64;Api&＃xff1a;用在类上&＃xff0c;说明该类的作用

&＃64;ApiOperation&＃xff1a;用在方法上&＃xff0c;说明方法的作用

&＃64;ApiIgnore&＃xff1a;使用该注解忽略这个API

&＃64;ApiImplicitParams&＃xff1a;用在方法上包含一组参数说明

&＃64;ApiImplicitParam&＃xff1a;用在&＃64;ApiImplicitParams注解中&＃xff0c;指定一个请求参数的各个方面

paramType&＃xff1a;参数放在哪个地方

header-->请求参数的获取&＃xff1a;&＃64;RequestHeader

query-->请求参数的获取&＃xff1a;&＃64;RequestParam

path&＃xff08;用于restful接口&＃xff09;-->请求参数的获取&＃xff1a;&＃64;PathVariable

body&＃xff08;不常用&＃xff09;

form&＃xff08;不常用&＃xff09;

name&＃xff1a;参数名

dataType&＃xff1a;参数类型

required&＃xff1a;参数是否必须传

value&＃xff1a;参数的意思

defaultValue&＃xff1a;参数的默认值

&＃64;ApiResponses&＃xff1a;用于表示一组响应

&＃64;ApiResponse&＃xff1a;用在&＃64;ApiResponses中&＃xff0c;一般用于表达一个错误的响应信息

code&＃xff1a;数字&＃xff0c;例如400

message&＃xff1a;信息&＃xff0c;例如"请求参数没填好"

response&＃xff1a;抛出异常的类

&＃64;ApiModel&＃xff1a;描述一个Model的信息&＃xff08;这种一般用在post创建的时候&＃xff0c;使用&＃64;RequestBody这样的场景&＃xff0c;请求参数无法使用&＃64;ApiImplicitParam注解进行描述的时候&＃xff09;

&＃64;ApiModelProperty&＃xff1a;描述一个model的属性

*/

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title("Demo使用Swagger2构建RESTful APIs")

.description("微信打卡服务")

.contact(new Contact("Jaycekon", "http://petstore.swagger.io/v2/swagger.json", "jaycekon&＃64;163.com"))

.version("1.0")

.build();

}

}

4.3 在需要生成Api 的接口添加注解:

&＃64;Api(tags &＃61; "测试用例")

&＃64;RestController

&＃64;RequestMapping(value&＃61;"/users") // 通过这里配置使下面的映射都在/users下&＃xff0c;可去除

public class UserController {

&＃64;ApiOperation(value&＃61;"获取用户列表", notes&＃61;"")

&＃64;RequestMapping(value&＃61;{""}, method&＃61; RequestMethod.GET)

public List getUserList() {

return new ArrayList<>();

}

&＃64;ApiOperation(value&＃61;"创建用户", notes&＃61;"根据User对象创建用户")

&＃64;ApiImplicitParam(name &＃61; "user", value &＃61; "用户详细实体user", required &＃61; true, dataType &＃61; "User")

&＃64;RequestMapping(value&＃61;"", method&＃61;RequestMethod.POST)

public String postUser(&＃64;RequestBody User user) {

return "success";

}

&＃64;ApiOperation(value&＃61;"获取用户详细信息", notes&＃61;"根据url的id来获取用户详细信息")

&＃64;ApiImplicitParam(name &＃61; "id", value &＃61; "用户ID", required &＃61; true, dataType &＃61; "Long")

&＃64;RequestMapping(value&＃61;"/{id}", method&＃61;RequestMethod.GET)

public User getUser(&＃64;PathVariable Long id) {

return new User();

}

&＃64;ApiOperation(value&＃61;"更新用户详细信息", notes&＃61;"根据url的id来指定更新对象&＃xff0c;并根据传过来的user信息来更新用户详细信息")

&＃64;ApiImplicitParams({

&＃64;ApiImplicitParam(name &＃61; "id", value &＃61; "用户ID", required &＃61; true, dataType &＃61; "Long"),

&＃64;ApiImplicitParam(name &＃61; "user", value &＃61; "用户详细实体user", required &＃61; true, dataType &＃61; "User")

})

&＃64;RequestMapping(value&＃61;"/{id}", method&＃61;RequestMethod.PUT)

public String putUser(&＃64;PathVariable Long id, &＃64;RequestBody User user) {

return "success";

}

&＃64;ApiOperation(value&＃61;"删除用户", notes&＃61;"根据url的id来指定删除对象")

&＃64;ApiImplicitParam(name &＃61; "id", value &＃61; "用户ID", required &＃61; true, dataType &＃61; "Long")

&＃64;RequestMapping(value&＃61;"/{id}", method&＃61;RequestMethod.DELETE)

public String deleteUser(&＃64;PathVariable Long id) {

return "success";

}

}

就能看到前文所展示的RESTful API的页面。我们可以再点开具体的API请求&＃xff0c;以POST类型的/users请求为例&＃xff0c;可找到上述代码中我们配置的Notes信息以及参数user的描述信息&＃xff0c;如下图所示。

4、接入Jenkins&SonarQube

项目框架搭建好后&＃xff0c;我们可以通Jenkins 进行项目的自动发版&＃xff0c;以及SonarQube 进行代码质量检测。在接入钱&＃xff0c;我们需要将项目打包成war包&＃xff0c;需要进行以下修改&＃xff1a;

1、修改项目打包类型&＃xff1a;

com.Jaycekon

demo

0.0.1-SNAPSHOT

war

2、修改Application.java 文件&＃xff1a;

&＃64;SpringBootApplication

public class DemoApplication extends SpringBootServletInitializer {

&＃64;Override

protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {

return application.sources(DemoApplication.class);

}

public static void main(String[] args) {

SpringApplication.run(DemoApplication.class, args);

}

}

在我的上一篇博客&＃xff0c;哆啦A梦的传送门&＃xff0c;已经讲解了一些基本配置方法&＃xff0c;这里为大家讲解一下&＃xff0c;接入SonarQube 进行代码质量检测的配置&＃xff08;需要本地安装SonarQube服务&＃xff09;。

首先需要在MetaData 中&＃xff0c;加入SonarQube 的项目名&＃xff08;新建的命名&＃xff09;&＃xff1a;

然后在Post Steps 中选择添加 Execute SonarQube Scanner&＃xff1a;

在配置好这两项后&＃xff0c;Jenkins 在编译文件时&＃xff0c;就会执行SonarQube 代码质量检测。

最后&＃xff0c;我们可以设置项目在编译完后&＃xff0c;执行shell 脚本&＃xff0c;进行项目的自动发版&＃xff1a;

项目编译完后&＃xff0c;会找到项目下的playbook&＃xff0c;执行里面的脚本&＃xff0c;将我们的项目部署到设定的服务器中。

总结 &＃xff1a;

本篇文章为大家带来了Spring-boot 的架构搭建&＃xff0c;主要使用到了目前较为流行的技术。希望对大家有所帮助&＃xff0c;如果大家有任何疑问请给我留言&＃xff0c;小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持&＃xff01;