這篇文章將為大家詳細(xì)講解有關(guān)怎么利用Spring Boot 搭建一個(gè)微服務(wù)框架，文章內(nèi)容質(zhì)量較高，因此小編分享給大家做個(gè)參考，希望大家閱讀完這篇文章后對(duì)相關(guān)知識(shí)有一定的了解。
創(chuàng)新互聯(lián)為企業(yè)級(jí)客戶提高一站式互聯(lián)網(wǎng)+設(shè)計(jì)服務(wù)，主要包括網(wǎng)站制作、做網(wǎng)站、成都app軟件開(kāi)發(fā)、微信小程序開(kāi)發(fā)、宣傳片制作、LOGO設(shè)計(jì)等，幫助客戶快速提升營(yíng)銷能力和企業(yè)形象，創(chuàng)新互聯(lián)各部門(mén)都有經(jīng)驗(yàn)豐富的經(jīng)驗(yàn)，可以確保每一個(gè)作品的質(zhì)量和創(chuàng)作周期，同時(shí)每年都有很多新員工加入，為我們帶來(lái)大量新的創(chuàng)意。
前言：
SpringBoot是為了簡(jiǎn)化Spring應(yīng)用的創(chuàng)建、運(yùn)行、調(diào)試、部署等而出現(xiàn)的，使用它可以做到專注于Spring應(yīng)用的開(kāi)發(fā)，而無(wú)需過(guò)多關(guān)注XML的配置。
簡(jiǎn)單來(lái)說(shuō)，它提供了一堆依賴打包，并已經(jīng)按照使用習(xí)慣解決了依賴問(wèn)題---習(xí)慣大于約定。
Spring Boot默認(rèn)使用tomcat作為服務(wù)器，使用logback提供日志記錄。
Spring Boot的主要優(yōu)點(diǎn)：
技術(shù)棧：
1、使用Maven構(gòu)建項(xiàng)目
1.1 通過(guò) SPRING INITIALIZR 工具生產(chǎn)基礎(chǔ)項(xiàng)目
通過(guò)訪問(wèn)：http://start.spring.io/ 快速創(chuàng)建Spring-boot 的服務(wù)框架。
初始化相應(yīng)信息后，下載壓縮包。解壓完成后，用IDEA打開(kāi)項(xiàng)目，項(xiàng)目的目錄結(jié)構(gòu)：
總體流程：
解壓項(xiàng)目包，并用IDE以Maven項(xiàng)目導(dǎo)入，以IntelliJ IDEA 14為例：
1.2 導(dǎo)入Spring-boot 相關(guān)依賴
項(xiàng)目初始化時(shí)，相關(guān)依賴如下：
org.springframework.boot spring-boot-starter org.springframework.boot spring-boot-starter-test test org.springframework.boot spring-boot-devtools true
這里我們需要引入Web模塊，需要添加：
org.springframework.boot spring-boot-starter-web
1.3 啟動(dòng)項(xiàng)目
添加首頁(yè)控制層：
重慶分公司
重慶分公司
@RestController
public class IndexController {
@RequestMapping("index")
public String index() {
return "hello world!";
}
}運(yùn)行DemoApplication中的main方法，啟動(dòng)服務(wù)：
服務(wù)啟動(dòng)后， 訪問(wèn) http://localhost:8080/index ，可以看到頁(yè)面輸出Hello world！。
2、整合Mybatis
2.1 項(xiàng)目依賴
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 項(xiàng)目配置
修改resources 下的application.properties文件：
spring.datasource.url=jdbc:mysql://localhost:3306/test spring.datasource.username=root spring.datasource.password=root spring.datasource.driver-class-name=com.mysql.jdbc.Driver #實(shí)體類掃描包 mybatis.type-aliases-package=com.jaycekon.demo.model #Mapper.xml文件掃描目錄 mybatis.mapper-locations=classpath:mapper/*.xml #駝峰命名 mybatis.configuration.mapUnderscoreToCamelCase=true #tkmapper 工具類 mapper.mappers=com.Jaycekon.demo.util.MyMapper mapper.not-empty=false mapper.identity=MYSQL pagehelper.helperDialect=mysql pagehelper.reasonable=true pagehelper.supportMethodsArguments=true pagehelper.params=count=countSql
2.3 單元測(cè)試
創(chuàng)建實(shí)體類，我們引入Lombok相關(guān)依賴，用于避免數(shù)據(jù)Get Set方法的重復(fù)創(chuàng)建：
org.projectlombok lombok 1.16.18 provided
實(shí)體類最終的代碼如下：
@Data
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
public class User {
private int id;
private String username;
private String idCard;
private String phone;
private String password;
}可以看出，在添加了Lombok 之后，我們的Java 實(shí)體類代碼簡(jiǎn)潔了很多。
接下來(lái)，我們需要?jiǎng)?chuàng)建UserMapper 數(shù)據(jù)庫(kù)處理類。由于MyMapper 已經(jīng)幫我們實(shí)現(xiàn)了基本的CRUD操作，因此我們這里并不需要再重寫(xiě)操作，我可以先一個(gè)根據(jù)用戶名查找的方法：
@Mapper public interface UserMapper extends MyMapper{ @Select("select * from user where username=#{username}") User selectByName(String username); } MyMapper 類位于util 目錄下： public interface MyMapper extends Mapper , MySqlMapper { }
這里需要注意，MyMapper 與我們的實(shí)體類Mapper 不能放在同一個(gè)目錄。
測(cè)試類：
@RunWith(SpringRunner.class)
@SpringBootTest
@MapperScan("com.Jaycekon.demo.mapper")
public class UserMapperTest {
@Autowired
private UserMapper mapper;
@Test
public void testInset() {
User user = new User(1, "Jaycekon","1234","1234","123");
int i = mapper.insert(user);
Assert.assertNotEquals(0, i);
}
@Test
public void testSelect(){
User user = mapper.selectByName("Jaycekon");
Assert.assertNotEquals(null,user);
}
}3、整合Redis
3.1 相關(guān)依賴
Spring Boot提供的數(shù)據(jù)訪問(wèn)框架Spring Data Redis基于Jedis。可以通過(guò)引入 spring-boot-starter-redis 來(lái)配置依賴關(guān)系。
org.springframework.boot spring-boot-starter-redis
3.2 Redis 配置
1、Spring-boot 連接單機(jī)版Redis 的配置如下：
# REDIS (RedisProperties) # Redis數(shù)據(jù)庫(kù)索引（默認(rèn)為0） spring.redis.database=0 # Redis服務(wù)器地址 spring.redis.host=localhost # Redis服務(wù)器連接端口 spring.redis.port=6379 # Redis服務(wù)器連接密碼（默認(rèn)為空） spring.redis.password= # 連接池最大連接數(shù)（使用負(fù)值表示沒(méi)有限制） spring.redis.pool.max-active=8 # 連接池最大阻塞等待時(shí)間（使用負(fù)值表示沒(méi)有限制） spring.redis.pool.max-wait=-1 # 連接池中的最大空閑連接 spring.redis.pool.max-idle=8 # 連接池中的最小空閑連接 spring.redis.pool.min-idle=0 # 連接超時(shí)時(shí)間（毫秒） spring.redis.timeout=0
2、Spriig-boot 連接Sentinel 哨兵集群配置：
# REDIS (RedisProperties) # Redis數(shù)據(jù)庫(kù)索引（默認(rèn)為0） spring.redis.database=0 # Redis服務(wù)器地址 #spring.redis.host=localhost # Redis服務(wù)器連接端口 #spring.redis.port=6379 # Redis服務(wù)器連接密碼（默認(rèn)為空） spring.redis.password= # 連接池最大連接數(shù)（使用負(fù)值表示沒(méi)有限制） spring.redis.pool.max-active=8 # 連接池最大阻塞等待時(shí)間（使用負(fù)值表示沒(méi)有限制） spring.redis.pool.max-wait=-1 # 連接池中的最大空閑連接 spring.redis.pool.max-idle=8 # 連接池中的最小空閑連接 spring.redis.pool.min-idle=0 # 連接超時(shí)時(shí)間（毫秒） spring.redis.timeout=0 #哨兵監(jiān)聽(tīng)redis server名稱 spring.redis.sentinel.master=cn-test-master #哨兵的配置列表 spring.redis.sentinel.nodes=localhost:26379,localhost:36379,localhost:46379
3.3 Redis 操作工具類
1、StringRedisTemplate 工具類
StringRedisTemplate 工具類可以解決字符串級(jí)別的Redis操作。在寫(xiě)好配置后，可以直接通過(guò)Autowried 就可以注入對(duì)象。
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(Application.class)
public class ApplicationTests {
@Autowired
private StringRedisTemplate stringRedisTemplate;
@Test
public void test() throws Exception {
// 保存字符串
stringRedisTemplate.opsForValue().set("aaa", "111");
Assert.assertEquals("111", stringRedisTemplate.opsForValue().get("aaa"));
}
}2、RedisTemplate
可以處理大部分的序列化操作，在這里我封裝了一個(gè)簡(jiǎn)化Redis工具類，后續(xù)可以繼續(xù)優(yōu)化。
@Component
public class RedisComponent {
@Autowired
//操作字符串的template，StringRedisTemplate是RedisTemplate的一個(gè)子集
private StringRedisTemplate stringRedisTemplate;
private Logger logger = LoggerFactory.getLogger(RedisComponent.class);
@Autowired
// RedisTemplate，可以進(jìn)行所有的操作
private RedisTemplate redisTemplate;
public void set(String key, String value) {
ValueOperations ops = this.stringRedisTemplate.opsForValue();
boolean bExistent = 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 依賴：
io.springfox springfox-swagger2 2.7.0 io.springfox springfox-swagger-ui 2.7.0
4.2 創(chuàng)建Swagger2 配置類：
在Application.java 同級(jí)創(chuàng)建一個(gè)Swagger2 的配置類：
@Configuration
@EnableSwagger2
public class Swagger2 {
@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使用說(shuō)明：
@Api：用在類上，說(shuō)明該類的作用
@ApiOperation：用在方法上，說(shuō)明方法的作用
@ApiIgnore：使用該注解忽略這個(gè)API
@ApiImplicitParams：用在方法上包含一組參數(shù)說(shuō)明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一個(gè)請(qǐng)求參數(shù)的各個(gè)方面
paramType：參數(shù)放在哪個(gè)地方
header-->請(qǐng)求參數(shù)的獲?。篅RequestHeader
query-->請(qǐng)求參數(shù)的獲?。篅RequestParam
path（用于restful接口）-->請(qǐng)求參數(shù)的獲?。篅PathVariable
body（不常用）
form（不常用）
name：參數(shù)名
dataType：參數(shù)類型
required：參數(shù)是否必須傳
value：參數(shù)的意思
defaultValue：參數(shù)的默認(rèn)值
@ApiResponses：用于表示一組響應(yīng)
@ApiResponse：用在@ApiResponses中，一般用于表達(dá)一個(gè)錯(cuò)誤的響應(yīng)信息
code：數(shù)字，例如400
message：信息，例如"請(qǐng)求參數(shù)沒(méi)填好"
response：拋出異常的類
@ApiModel：描述一個(gè)Model的信息（這種一般用在post創(chuàng)建的時(shí)候，使用@RequestBody這樣的場(chǎng)景，請(qǐng)求參數(shù)無(wú)法使用@ApiImplicitParam注解進(jìn)行描述的時(shí)候）
@ApiModelProperty：描述一個(gè)model的屬性
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Demo使用Swagger2構(gòu)建RESTful APIs")
.description("微信打卡服務(wù)")
.contact(new Contact("Jaycekon", "http://petstore.swagger.io/v2/swagger.json", "jaycekon@163.com"))
.version("1.0")
.build();
}
}4.3 在需要生成Api 的接口添加注解:
@Api(tags = "測(cè)試用例")
@RestController
@RequestMapping(value="/users") // 通過(guò)這里配置使下面的映射都在/users下，可去除
public class UserController {
@ApiOperation(value="獲取用戶列表", notes="")
@RequestMapping(value={""}, method= RequestMethod.GET)
public List getUserList() {
return new ArrayList<>();
}
@ApiOperation(value="創(chuàng)建用戶", notes="根據(jù)User對(duì)象創(chuàng)建用戶")
@ApiImplicitParam(name = "user", value = "用戶詳細(xì)實(shí)體user", required = true, dataType = "User")
@RequestMapping(value="", method=RequestMethod.POST)
public String postUser(@RequestBody User user) {
return "success";
}
@ApiOperation(value="獲取用戶詳細(xì)信息", notes="根據(jù)url的id來(lái)獲取用戶詳細(xì)信息")
@ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long")
@RequestMapping(value="/{id}", method=RequestMethod.GET)
public User getUser(@PathVariable Long id) {
return new User();
}
@ApiOperation(value="更新用戶詳細(xì)信息", notes="根據(jù)url的id來(lái)指定更新對(duì)象，并根據(jù)傳過(guò)來(lái)的user信息來(lái)更新用戶詳細(xì)信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long"),
@ApiImplicitParam(name = "user", value = "用戶詳細(xì)實(shí)體user", required = true, dataType = "User")
})
@RequestMapping(value="/{id}", method=RequestMethod.PUT)
public String putUser(@PathVariable Long id, @RequestBody User user) {
return "success";
}
@ApiOperation(value="刪除用戶", notes="根據(jù)url的id來(lái)指定刪除對(duì)象")
@ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long")
@RequestMapping(value="/{id}", method=RequestMethod.DELETE)
public String deleteUser(@PathVariable Long id) {
return "success";
}
} 完成上述代碼添加上，啟動(dòng)Spring Boot程序，訪問(wèn)：http://localhost:8080/swagger-ui.html
。
就能看到前文所展示的RESTful API的頁(yè)面。我們可以再點(diǎn)開(kāi)具體的API請(qǐng)求，以POST類型的/users請(qǐng)求為例，可找到上述代碼中我們配置的Notes信息以及參數(shù)user的描述信息，如下圖所示。
4、接入Jenkins&SonarQube
項(xiàng)目框架搭建好后，我們可以通Jenkins 進(jìn)行項(xiàng)目的自動(dòng)發(fā)版，以及SonarQube 進(jìn)行代碼質(zhì)量檢測(cè)。在接入錢(qián)，我們需要將項(xiàng)目打包成war包，需要進(jìn)行以下修改：
1、修改項(xiàng)目打包類型：
com.Jaycekon demo 0.0.1-SNAPSHOT war
2、修改Application.java 文件：
@SpringBootApplication
public class DemoApplication extends SpringBootServletInitializer {
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
return application.sources(DemoApplication.class);
}
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}在我的上一篇博客，哆啦A夢(mèng)的傳送門(mén)，已經(jīng)講解了一些基本配置方法，這里為大家講解一下，接入SonarQube 進(jìn)行代碼質(zhì)量檢測(cè)的配置（需要本地安裝SonarQube服務(wù)）。
首先需要在MetaData 中，加入SonarQube 的項(xiàng)目名（新建的命名）：
然后在Post Steps 中選擇添加 Execute SonarQube Scanner：
在配置好這兩項(xiàng)后，Jenkins 在編譯文件時(shí)，就會(huì)執(zhí)行SonarQube 代碼質(zhì)量檢測(cè)。
最后，我們可以設(shè)置項(xiàng)目在編譯完后，執(zhí)行shell 腳本，進(jìn)行項(xiàng)目的自動(dòng)發(fā)版：
項(xiàng)目編譯完后，會(huì)找到項(xiàng)目下的playbook，執(zhí)行里面的腳本，將我們的項(xiàng)目部署到設(shè)定的服務(wù)器中。
關(guān)于怎么利用Spring Boot 搭建一個(gè)微服務(wù)框架就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，可以學(xué)到更多知識(shí)。如果覺(jué)得文章不錯(cuò)，可以把它分享出去讓更多的人看到。
