spring boot开发遇到坑之spring-boot-starter-web配置文件使用教程
spring boot简介
spring boot是最近非常流行的,在spring的框架上改进的框架。该框架的目的是为了提高开发人员的速度,降低配置的难度等等,极大了简化了开发流程。具体的详细的说明请参考官方文档。在日常工作中,由于需要搭建一套环境或者框架的机会非常的少,大部分都是在原有的基础上开发,所以当让你搭建一个简单的框架,就会出现各种各样的困难,比如说,我在搭建的一个服务器的时候,准备了一个小的demo,原以为非常的简单,结果遇到了各种各样的问题,而发现网上的博客都是零零散散的讲一些点,很难有一个完整的流程,包括可能会遇到的问题。这里对搭建一个简单的项目流程做一个详细的总结,方便日后参考,同时这一篇博客也是为了下一篇博客tengine反向代理服务器搭建做一点前置的基础准备。
spring-boot的2大优点:
1.基于spring框架的“约定优先于配置(coc)”理念以及最佳实践之路。
2.针对日常企业应用研发各种场景的spring-boot-starter自动配置依赖模块,且“开箱即用”(约定spring-boot-starter- 作为命名前缀,都位于org.springframenwork.boot包或者命名空间下)。
本篇我将继续向小伙伴介绍springboot配置文件的配置,已经全局配置参数如何使用,好了下面开始我们今天的内容介绍。
我们知道spring boot支持容器的自动配置,默认是tomcat,当然我们也是可以进行修改的:
1、首先我们排除spring-boot-starter-web依赖中的tomcat:在pom文件中排除tomcat的starter
<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>
2、加入jetty容器
<dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-jetty</artifactid> </dependency>
这样我们的springboot容器就修改成jetty容器了。
为了方便我们的调试,这里给大家推荐一款http调试工具:postman
下面我们聊一下springboot的全局配置文件:application.properties
在开发中一定遇到过这样的需求,就是修改我们的容器访问端口,既然springboot默认加载容器,那么端口设置当然是通过配置文件来控制的,相当方便我们只需要在配置文件中添加:
server.port=6666
这样我们的容器端口就修改为6666了。
我们还可以通过配置文件来设置项目访问别名:
server.context-path=/springboot
这样我们启动项目通过即可访问到我们的项目
以上只是springboot配置文件配置的冰山一角,比如我们还可以设置数据库连接配置(database),设置开发环境配置,部署环境配置,实现两者之间的无缝切换。
下面我们一起了解一下关于springboot的controller的使用,springboot为我们提供了三个注解:
上一篇我们使用的便是@restcontroller,下面我们来一起使用@controller试试:
@controller //@responsebody public class requesttest { /** * 不对请求方式限制 * @return */ @requestmapping(value = "/req") public string req(){ return "success"; } }
当我们在浏览器输入回车,发现404
{ "timestamp": 1515332935215, "status": 404, "error": "not found", "message": "no message available", "path": "/springboot1/req" }
这是为什么呢?这是因为@controller必须配合模板使用,所以我们这里打开maven的pom文件,添加spingboot的模板:
<!-- springboot模板 --> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-thymeleaf</artifactid> </dependency>
然后在我们项目的resources目录下找到templates(如过没有,新建一个,但一定要注意文件夹名称必须保持一致),然后创建一个success.html这样我们再次启动项目,访问刚刚的地址,是不是就ok了。
不过这里需要说明一点,现在的企业级开发都是前后端分离,我们做后台服务只需要返回对应的数据即可,当然使用模板还有一个弊端,那就是性能会造成一定的损耗,所以这里大家简单了解即可。
上面的介绍中已经说了,@controller+@responsebody相当于@restcontroller,所以这里推荐大家使用@restcontroller。
下面我们来介绍介绍一下@requestmapping(value = "/req"),这个注解相信大家已经知道他的用法了,当然这个注解不但可以使用在方法上,同样适用于类。
@restcontroller //@controller //@responsebody @requestmapping(value = "/test") public class requesttest { /** * 不对请求方式限制 * @return */ @requestmapping(value = "/req") public string req(){ return "success"; } /** * 限制请求方式为get * @return */ @requestmapping(value = "/req1", method = requestmethod.get) public string req1(){ return "success"; } /** * 限制请求方式为post * @return */ @requestmapping(value = "/req2", method = requestmethod.post) public string req2(){ return "success"; } }
对于method相信看到这里你一定已经知道他的用处了,是的指定访问类型,没有设置默认任何方式都可以访问。不知道小伙伴是否想到如果在类的@requestmapping设置过method那么类中的方法默认继承,当然也可以在方法处单独设定,优先级的问题,小伙伴自己尝试一下吧。
下面我将给大家介绍一下如何在controller中的访问配置文件中的常量。首先我们在配置文件中添加:
name=hpugs age=35 content=name:${name};age:${age}
我们在配置文件中使用常量,通过${}来使用。
下面我们在controller中将参数注入:
//注入配置文件中的参数 @value("${name}") private string name; @value("${age}") private integer age; @value("${content}") private string content; @requestmapping(value = "/req3", method = requestmethod.get) public string req3(){ return "name=" + name; } @requestmapping(value = "/req4", method = requestmethod.get) public string req4(){ return "age=" + age; } @requestmapping(value = "/req5", method = requestmethod.get) public string req5(){ return "content=" + content; }
启动我们的项目访问一下试试。
这样的使用如果你感觉还不过瘾,这里再教大家一招:我们通过类映射配置文件,借助类来进行参数使用,相对单个参数注入要方便一些,首先创建一个java类
@component @configurationproperties(prefix = "userinfo") public class userinfo { private string names; private integer age; private string content; public integer getage() { return age; } public string getnames() { return names; } public void setnames(string names) { this.names = names; } public void setage(integer age) { this.age = age; } public string getcontent() { return content; } public void setcontent(string content) { this.content = content; } }
然后在我们的配置文件中设置参数:
userinfo.names=小破孩 userinfo.age=25 userinfo.content=name:${userinfo.names};age:${userinfo.age}
接线来使我们的controller:
//注入对象 @autowired private userinfo userinfo; @requestmapping(value = "/req6", method = requestmethod.get, produces="text/plain;charset=utf-8") public string req6(){ return "name=" + userinfo.getnames(); } @requestmapping(value = "/req7", method = requestmethod.get) public string req7(){ return "age=" + userinfo.getage(); } @requestmapping(value = "/req8", method = requestmethod.get) public string req8(){ return "content=" + userinfo.getcontent(); }
好了重启我们的项目访问试试看。
小伙伴们不知道遇到这个问题没?出现了中文乱码,首先大家先不要着急,我们先看另外一种springboot的配置文件:application.yml。这个配置文件通过换行空格来替换“;”,我们看一下同样的配置在yml下面如何配置:
server: port: 8888 context-path: /springboot1 name: hpugs age: 35 content: name:${name};age:${age} userinfo: names: 小破孩 age: 25 content: name:${userinfo.names};age:${userinfo.age}
现在我们启动项目运行试一试。
回到上面的乱码问题,当我们使用yml时是不是没有出现乱码,小伙伴是不是有点郁闷了,这是为什么呢?这是因为.properties文件使用的是unicode的编码形式,所以当我们输入中文时会出现乱码。当然引乱码的还有一种原因那就是我能的编码设置和前端不一致,这个我们通过在配置文件中添加:
spring: http: encoding: force: true charset: utf-8 enabled: true server: tomcat: uri-encoding: utf-8
来进行控制。这里再给大家介绍一下开发小技巧,springboot为我们提供了在不同开发环境下的不同配置文件解决方法:
#yml格式 spring: profiles: active: prod #.properties格式 spring.profiles.active=dev
总结
以上所述是小编给大家介绍的spring boot开发遇到坑之spring-boot-starter-web配置文件使用教程,希望对大家有所帮助