提供网站建设定制,旅行社,个人网站注册名称,点点 wordpress前期回顾
springboot项目常见的配置文件类型有哪些#xff1f;哪种类型的优先级最高
yml properties yaml
读取配置文件里的数据用什么注解#xff1f;
value
restful风格
RESTful 风格与传统的 HTTP 请求方式相比#xff0c;更加简洁#xff0c;安全#xff0c;能隐…前期回顾
springboot项目常见的配置文件类型有哪些哪种类型的优先级最高
yml properties yaml
读取配置文件里的数据用什么注解
value
restful风格
RESTful 风格与传统的 HTTP 请求方式相比更加简洁安全能隐藏资源的访问行为无法从访问地址得知对资源是何种操作 可见很多 RESTful 风格的访问地址都是一样的只用行为动作区分了不同的访问对外隐藏了真实的操作。此外资源描述部分一般用复数如 books当然这种操作是只是一种约定不是规范但大多数人都这样做。
RestController
RequestMapping(/users)
public class UserController {PostMappingpublic String addUser(RequestBody UserInfo userInfo){System.out.println(新增用户信息userInfo);return 新增用户成功;}DeleteMapping(/{id})public String del(PathVariable Integer id){System.out.println(删除用户IDid);return 删除用户成功;}PutMappingpublic String update(RequestBody UserInfo userInfo){System.out.println(修改后);return 修改用户成功;}GetMapping(/{id})public String getUser(PathVariable Integer id){System.out.println(用户IDid);return 查询用户ID成功;}GetMappingpublic String getUsers(){System.out.println(查询所有的用户);return 查询所有的用户;}}利用postman测试
{username:zhangsan,password:z3,mobilephone:15336574540
}静态资源访问
默认静态资源访问
Spring Boot 规定了静态资源可以放在以下 5 个目录中的任意一个下面
classpath:/META-INF/resources/
classpath:/resources/
classpath:/static/
classpath:/public/
/
Spring Boot 项目创建完成后默认情况下提供了classpath:/static/目录一般情况下在此放置静态资源即可
自定义静态资源
1.在application.yml配置
web:upload-path: D:/upimgs/
spring:mvc:static-path-pattern: /**web:resources:static-locations:file:${web.upload-path},classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/2.配置类的方式
Configuration
public class WebConfig extends WebMvcConfigurationSupport {Overrideprotected void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler(/**).addResourceLocations(classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/,file:D:/upimgs/);}
}
路径映射
在 Spring Boot 的 Web 项目中所有页面都需要通过控制器才能访问到包括没有数据的页面。对于这种只是完成简单的跳转的没有数据的页面可以直接配置路径映射不再经过控制器。 1.导入依赖
dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-thymeleaf/artifactId
/dependency2.在application.yml中添加thymeleaf的配置
spring:thymeleaf:prefix: classpath:/templates/suffix: .html默认就是这样所以可以省略不写 3.在项目的 resource/ templates 目录下创建 add.html 文件和 register.html 文件 4.在项目的 MyWebMvcConfig 配置类中重写 addViewControlles 方法
Override
protected void addViewControllers(ViewControllerRegistry registry) {registry.addViewController(/add).setViewName(add);registry.addViewController(/register).setViewName(register);
}5.运行测试浏览器访问 http://localhost:8080/add结果访问到了 add.html 页面 访问 http://localhost:8080/register结果访问到了 register.html 页面
CORS 跨域资源访问
回顾一下浏览器的同源策略 假设后端的主页 URL 是 http://sike.com/index.html
CORS 基础
CORS 是一个 W3C 的一种跨域资源共享技术标准目的是为了解决前端的跨域请求问题是英文 Cross-origin resource sharing 的缩写全称是“跨域资源共享”它允许浏览器向跨源(协议 域名 端口)服务器发出 XMLHttpRequest 请求从而克服了 AJAX 只能同源使用的限制。
解决方案
1.CrossOrigin 注解实现方案 直接在控制器需要跨域访问的方法上面添加CrossOrigin 注解并配置跨域属性主要属性有
value表示支持的域即哪些来源的域允许访问。maxAge表示预检信息的有效缓存时间,单位是秒allowedHeaders表示允许的请求头。 GetMapping(/getMsg)CrossOrigin(value http://localhost:8081)public String getMsg(){return GET success;}DeleteMapping(/delMsg)CrossOrigin(value http://localhost:8081)public String delMsg(){return delete success;}新建一个新的web项目换个端口启动发起ajax跨域请求。
script src/jquery-1.8.3.min.js/scriptbody
button onclicksendAjax()点击发送ajax请求/button
/bodyscriptfunction sendAjax() {$.ajax({url:http://localhost/getMsg,type:get,success:function (result) {alert(result)}})}
/script2.基于过滤器的实现方案
Configuration
public class CorsFilterConfig {Beanpublic FilterRegistrationBeanCorsFilter corsFilter(){FilterRegistrationBeanCorsFilter corsFilterFilterRegistrationBeannew FilterRegistrationBean();UrlBasedCorsConfigurationSource sourcenew UrlBasedCorsConfigurationSource();CorsConfiguration corsConfigurationnew CorsConfiguration();corsConfiguration.addAllowedHeader(*);//允许的请求头
// corsConfiguration.addAllowedOrigin(*);corsConfiguration.addAllowedOriginPattern(*);//允许的origin域名corsConfiguration.setAllowCredentials(true); //是否允许发cookiecorsConfiguration.setMaxAge(3600L);//从预检请求得到相应的最大时间默认30分钟corsConfiguration.setAllowedMethods(Arrays.asList(GET,POST,DELETE,PUT)); //允许的请求方法source.registerCorsConfiguration(/**,corsConfiguration);//指定可以跨域的路径corsFilterFilterRegistrationBean.setFilter(new CorsFilter(source));corsFilterFilterRegistrationBean.setOrder(-1);return corsFilterFilterRegistrationBean;}
}
统一响应数据格式
Data
NoArgsConstructor
AllArgsConstructor
public class ResponseDataT {private String code;//响应状态码private String errorMsg;//用于封装异常信息正常返回一般为null即可private Boolean result;//表示执行成功还是失败private T data;//封装返回数据
}Spring Boot 异常处理
自定义错误页
如果不需要向用户展示错误的详细信息可以把错误信息定义成静态页面简单地输出自定义的出错啦或找不到之类的网页。 在静态文件路径下创建 error 目录并创建 4xx.html 或 5xx.html 页面则发生 4 开头的错误状态码代表的异常时将返回 4xx.html当发生 5 开头的错误状态码代表的异常时将返回5xx.html。还可以用更具体的错误状态码命名的文件如 404.html则发生 404 错误时则会直接返回当发生 403 等错误时返回 4xx。如果最后都找到不到的话还会返回springboot 自带的默认白页。
ControllerAdvice 全局统一异常处理
如果客户端需要比较具体的异常信息则不能用上述简单方法一般要用注解ControllerAdvice 进行统一异常处理如果返回 json 格式的数据也可以使用RestControllerAdvice只需要创建一个类加上这个注解就可以捕捉到异常然后类中各个方法再用ExceptionHandler 注解来对具体的各个异常分别进行处理
RestControllerAdvice
public class GlobalExceptionHandler {ExceptionHandler(NullPointerException.class)public ResponseData exception(NullPointerException exception) {return new ResponseData(500, 空指针异常,false, null);}ExceptionHandler(IndexOutOfBoundsException.class)public ResponseData exception(IndexOutOfBoundsException exception) {return new ResponseData(500, 数组越界异常, false,null);}ExceptionHandler(Exception.class)public ResponseData exception(Exception exception) {return new ResponseData(500, exception.getMessage(),false, null);}}测试类 RequestMapping(/exception)
RestController
public class ExceptionController {GetMapping(/test1)public ResponseData test1() {UserInfo userInfo null;userInfo.setUsername(zhangsan);return new ResponseData(200,null,true,userInfo);}GetMapping(/test2)public ResponseData test2() {int[] arr {1,2,3};System.out.println(arr[3]);//发生越界针异常//以下是正常业务代码 省略return new ResponseData(200,null,true,arr);}GetMapping(/test3)public ResponseData test3() {int i10/0; //发生算术异常//以下是正常业务代码return new ResponseData(200,null,true,i);}}文件上传
单文件上传
Spring Boot 提供了自动配置类 MultipartAutoConfigure 可以实现文件上传只需导入 spring-boot-starter-web 以及配置 spring.servlet.multipart.enabledtrue 即可生效。#表示是否开启文件上传支持,默认为true
spring.servlet.multipart.enabledtrue
#修改文件上传临时保存路径
spring.servlet.multipart.locationC:/temp
#单个上传文件的最大限制 默认是1M
spring.servlet.multipart.max-file-size2MB
#多个上传文件的最大限制 默认是10M
spring.servlet.multipart.max-request-size10MB
#文件写入磁盘的阈值
spring.servlet.multipart.file-size-threshold0BRestController
RequestMapping(/upload)
public class FileUploadController {PostMappingpublic ResponseData upload(MultipartFile file , HttpServletRequest request){if (!file.isEmpty()) {//默认是上传到项目的webapp下String realPath request.getServletContext().getRealPath(/uploadFile);File savePath new File(realPath);if (!savePath.exists()) {savePath.mkdirs();}String fileName UUID.randomUUID().toString().replace(-,);String originalFilename file.getOriginalFilename();String suffix originalFilename.substring(originalFilename.indexOf(.));File saveFile new File(savePath,fileNamesuffix);try {file.transferTo(saveFile);return new ResponseData(200,上传成功,true,null);} catch (IOException e) {return new ResponseData(500,上传出现异常,false,null);}}else{return new ResponseData(500,文件必传,false,null);}}
}多文件上传 Thymeleaf 视图层技术
使用过程
1.加依赖
dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-thymeleaf/artifactId
/dependency2.配置thymeleaf模板视图解析器 在application. properties中可以添加关于Thymeleaf模板视图解释器的配置项也可以不添加使用默认值。参考代码如下: #关闭Thymeleaf缓存这样开发时方便测试无须重启
spring.thymeleaf.cachefalse
#设置Thymeleaf页面编码
spring.thymeleaf.encodingutf-8
#Thymeleaf模式
spring.thymeleaf.modeHTML5
#Thymeleaf页面的后缀
spring.thymeleaf.suffix.html
#Thymeleaf页面的存储路径前缀
spring.thymeleaf.prefixclasspath:/templates/
3.页面引入命名空间
!DOCTYPE html
html langen xmlns:thhttp://www.thymeleaf.org
headmeta charsetUTF-8titlehello/title
/head
body
欢迎用户span th:text${username}hello/span登录
/body
/html
4.创建控制器
Controller
RequestMapping(/thymeleaf)
public class ThymeleafController {GetMapping(/index)public String index(Model model){model.addAttribute(username,jf3q);return hello;}
}
基础语法
1.th:text文本的赋值与替换
div th:text${text1}将被替换掉的原始值/div如果替换的文本中有html代码的话浏览器不能识别
div th:text${text2}不能识别文本中的HTML标签/div控制器中加的代码 model.addAttribute(text2,h1hello world/h1);2.th:utext 跟th:text用法一样不同的是如果文本中包含 HTML 标签浏览器可以识别。
div th:utext${text2}能识别文本中的HTML标签/div3.th:value 给有 value 属性的 HTML 标签赋值
用户名input typetext th:value${username} /br/4.th:checked 用于决定单选或复选框是否选中
性别input typeradio th:checked${gender}男 /男
input typeradio th:checked${gender}女 /女br/5.th:selected 决定下拉选择框中的选项是否被选中
城市selectoption th:selected${city}北京北京/optionoption th:selected${city}上海上海/optionoption th:selected${city}广州广州/optionoption th:selected${city}深圳深圳/option
/select控制器中加city值
model.addAttribute(city,广州);6.th:each 用来遍历集合
User user1new User(1,李白,123);
User user2new User(2,杜甫,123);
ListUser usersnew ArrayList();
users.add(user1);
users.add(user2);
model.addAttribute(users,users);用户列表如下
table border1trth编号/thth用户名/thth密码/th/trtr th:eachuser:${users}td th:text${user.id}/tdtd th:text${user.username}/tdtd th:text${user.password}/td/tr
/table除了遍历元素还可于获取遍历的状态thymeleaf 提供如下状态
index当前的遍历索引从 0 开始count当前的遍历索引从 1 开始size被遍历变量里的元素数量。current每次遍历的遍历变量。even当前的遍历是否为偶数次。odd当前的遍历是否为奇数次first当前是否为首次遍历。last: 当前是否为最后一次遍历。 用户列表(含状态)如下
table border1trth编号/thth用户名/thth密码/thth索引号/thth是否第一个/thth是否最后一个/thth是否偶数次/th/trtr th:eachuser,state:${users}td th:text${user.id}/tdtd th:text${user.username}/tdtd th:text${user.password}/tdtd th:text${state.index}/tdtd th:text${state.first}/tdtd th:text${state.last}/tdtd th:text${state.even}/td/tr
/table7.th:if 选择结构控制数据是否在页面上显示当条件为 true 时将填充数据到闭合标签内部
div th:if${username}jf3q th:text该用户是管理员/div8.th:unless 选择结构当条件为 false 时将填充数据到闭合标签内部
div th:unless${username}jf3q th:text该用户是普通用户/div9.th:swith 与 th:case 多重选择分支结构
div th:switch${city}div th:case北京北京/divdiv th:case上海上海/divdiv th:case广州广州/divdiv th:case深圳深圳/divdiv th:case不确定/div
/div10.th:attr 11.th:class 与 th:style
spel表达式
Thymeleaf 提供了 KaTeX parse error: Expected EOF, got # at position 8: {}、*{}、#̲{}、{}四种占位符在{}…{} 用于获取 Model 中的字符串或对象如果是对象还可以用点运算符进一步获取对象的 属性值或方法。可以获取 Servlet 的各种内置对象也可以获取 Thymeleaf 的内置对象如 dates,numbers,strings,arrays,lists 等等。 2.{} 其中的号代表一个对象大括号里面的内容代表对象的属性通常要结合 th:object 属性一起使用th:object 用来获取一个对象然后再用*{}去获取对象的各个属性值。 3.#{} 用于读取取国际化 properties 文件的属性。 4.{}
Thymeleaf 表达式 Thymeaf 除了使用 SpEL 表达式外还有自己的表达式在${}的大括号中使用的表达式属于 SpEL 表达式而在 th:属性的双引号中应用的是 Thymeleaf 自身的表达式。1.比较运算 可以使用的运算符包括、、 、 ! 、 、 ,其中的和本身是 HTML 标签的关键字为了避免歧义可使用别名gt 对应lt 对应ge 对应le 对应not 对应eq 对应neq 或 nq 对应!。 2.三目运算 3.逻辑运算
是否登录span th:text${usernameadminpassword123}/span
内置对象
在 Thymeleaf 中的内置对象有
#ctx上下文对象。#request获取 HttpServletRequest 对象。#response获取 HttpServletResponse 对象。#session获取 HttpSession 对象#servletContext获取 HttpServletContext 对象#dates日期格式化内置对象具体方法可以参照 java.util.Date#calendars类似于#dates但是 java.util.Calendar 类的方法#numbers数字格式化#strings字符串格式化具体方法可以参照 java.lang.String如 startsWith、contains 等#objects参照 java.lang.Object#bools判断 boolean 类型的工具#arrays数组操作的工具#lists列表操作的工具参照 java.util.List#setsSet 集合操作工具参照 java.util.Set#mapsMap 集合操作工具参照 java.util.Map#aggregates操作数组或集合创建聚合的工具#messages
测试
模板片段
系统中的很多页面有很多公共内容例如标题栏、主菜单、侧边栏、页脚等这些公共内容可以提取放在一个称为“模板片段”的公共页面里面其它页面可以引用这个“模板片段”内容。1.模板片段的定义 普通 html 标签或 标签添加 th:fragment 属性这样这个标签及其内部的所有内容就定义为一个模板片段。语法是 th:fragment“模板片段名称”。 这里表示将 block 标签定义为一个模板片段模板片段的名称叫 loginForm定义了模板片段的当前 HTML 文件就称为模板模板名称就是 HTML 文档的名字不含后缀此处模板名称为 login。 2.引用片段 1插入整个模板 使用 th:insert 属性插入整个模板。 语法th:insert“~{模板名称}” 除此之外还可以使用 th:replace 和 th:include 插入。 2)插入模板片段 语法th:insert“~{模板名称::模板片断名称}” 插入模板中的其中一个指定名称的片断模板片断名可以对应 th:fragment 定义的名称也可以用类似 JQuery 选择器的语法选择部分片段。 3)th:insert、th:replace、th:include 的区别
th:insert将公共片段整个插入到声明引入的元素中th:replace将声明引入的元素替换为公共片段th:include将被引入的片段的内容包含进这个标签中
3.模板片段传入参数 带参数的模板片段定义语法th:fragment“模板片段名称(参数列表)”。参数列表指可以是一个或多个参数。并且在模板片段内部需要内容不同的位置使用参数使用方式 参数名称例如 s p a n t h : t e x t {参数名称}例如span th:text 参数名称例如spanth:text{参数} 。 引用语法~{模板名称::模板片断名称(参数列表)}。这个参数列表是有实际值的。
综合实例
Data
AllArgsConstructor
NoArgsConstructor
public class Student {private Integer id;private String name;private String gender;private Integer age;private String classname;} ListStudent students new ArrayList();students.add(new Student(1, 张三,女,20, 计科1班));students.add(new Student(2, 李四,男,21, 计科2班));students.add(new Student(3, 李白,男,18, 计科3班));model.addAttribute(students,students);return students;html langen xmlns:thhttp://www.thymeleaf.org
headmeta charsetUTF-8title学生列表/title
/head
bodytabletrtdid/tdtd姓名/tdtd性别/tdtd年龄/tdtd班级/td/trtr th:eachs:${students}td th:text${s.id}/tdtd th:text${s.name}/tdtdinput typeradio th:checked${s.gender}男 /男input typeradio th:checked${s.gender}女 /女/tdtd th:text${s.age}/tdtdselect option th:selected${s.classname}计科1班计科1班/optionoption th:selected${s.classname}计科2班计科2班/optionoption th:selected${s.classname}计科3班计科3班/option/select/td/tr
/table/body
/html接口文档 Swagger3.0
Swagger 是一个用于生成、描述、调用和可视化 RESTful 风格的 Web 服务框架最主 要的组件是 Swagger UI该组件提供了一个可视化的 UI 页面展示描述文件可以在该页面 中对相关接口进行查阅或做一些简单的接口请求。Swagger3.0 和之前版本的依赖不太一样dependencygroupIdio.springfox/groupIdartifactIdspringfox-boot-starter/artifactIdversion3.0.0/version/dependency常用注解
API用于类上表示标识这个类是 swagger 的资源tagsvaluehiddenApiOperation用于方法上表示一个 http 请求的动作valuenoteshttpMethod hiddenApiParam用于方法参数或字段说明表示对参数的添加元数据说明或是否 必填等namevaluerequiredApiModel用于类上表示对类进行说明用于参数用实体类接收value descriptionApiModelProperty用于方法或字段表示对 model 属性的说明或者数据操作更改 valuenamedataTyperequiredexamplehiddenApiIgnore用于类方法或方法参数上表示这个类或者方法或者参数被忽略 valueApiResponses用于方法上方法返回对象的说明多个 ApiResponseApiResponse用于方法上每个参数的说明codemessageresponseApiImplicitParams用于方法上包含一组参数说明多个 ApiImplicitParamApiImplicitParam 用于方法上表示单独的请求参数namevaluerequiredparamTypedataTypereadOnlyallowEmptyValuedefaultValue
springboot整合swagger流程
由于spring Boot 3.0 在写稿时仍然处于快速迭代中对 swagger3.0 的支持不太好故这里暂时退到最近一个稳定版本 spring boot2.7.1 来讲解 Spring Boot 整合 Swagger3。 1.加依赖 dependencygroupIdio.springfox/groupIdartifactIdspringfox-boot-starter/artifactIdversion3.0.0/version
/dependency
dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-web/artifactId
/dependencydependencygroupIdorg.projectlombok/groupIdartifactIdlombok/artifactIdoptionaltrue/optional
/dependency2.Application.properties 中添加如下配置
spring.mvc.pathmatch.matching-strategyANT_PATH_MATCHER这个配置的作用是将 SpringBoot 路径匹配模式修改为 AntPathMatcher。Spring Boot 2.6.0 开始使用基于 PathPatternParser 的路径匹配而 Springfox 版本一直没有更新还是使用 的 AntPathMatcher如果不这样配置将会抛出以下异常 3.创建实体类 User
Data
AllArgsConstructor
ApiModel(value 用户User类,description 描述用户User信息)
public class UserInfo {ApiModelProperty(value 用户id)private Integer id;ApiModelProperty(value 用户名)private String username;ApiModelProperty(value 密码)private String password;
}
4.创建配置类 SwaggerConfig 启用 Swagger
Configuration
EnableOpenApi
public class SwaggerConfig {Beanpublic Docket desertsApi(){return new Docket(DocumentationType.OAS_30).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage(com.example.swagger_demo.controller))//按包扫描,.paths(PathSelectors.any()).build().groupName(jf3q).enable(true);}private ApiInfo apiInfo(){return new ApiInfoBuilder().title(用户管理系统说明API文档)//标题.description(用户管理系统说明API文档)//描述.contact(new Contact(jfit, https://www.jf3q.com, 12345qq.com))//作者信息
// .termsOfServiceUrl(https://www.sike.com).version(1.0)//版本号.build();}
}5.controller
RestController
RequestMapping(/user)
Api(tags User操作接口)
public class UserInfoController {AutowiredUserInfoService userInfoService;GetMapping(/{id})ApiOperation(value 根据id查找用户对象, notes 根据id查找用户对象)public ResultVoUserInfo getUser(ApiParam(value 用户ID, example 1, required true)PathVariable Integer id){UserInfo userInfo userInfoService.getUser(id);return ResultVo.success(,userInfo);}GetMappingApiOperation(value 获取所有用户对象, notes 获取所有用户无需参数)public ResultVoListUserInfo getList(){ListUserInfo listuserInfoService.getList();return ResultVo.success(,list);}
}6.访问接口文档页面 http://localhost:端口/swagger-ui/index.html
美化ui界面
Swagger 自带的 UI 界面不是很好看可以使用流行的第三方 swagger-bootstrap-ui 进行 美化添加如下依赖重新启动访问地址http://localhost:端口/doc.html
dependencygroupIdcom.github.xiaoymin/groupIdartifactIdswagger-bootstrap-ui/artifactIdversion1.9.6/version
/dependency生产环境关闭swagger
一般 Swagger 只在开发和测试环境中使用不带到生产环境中去。可以通过修改配置类 SwaggerConfig 里面的代码 enable(true)为 enable(false)来快速关闭 Swagger。更好的办法是自动识别是生成环境还是开发或测试环境自动关闭或开启
Bean
public Docket desertsApi(Environment environment){//开发环境和测试环境
Profiles profilesProfiles.of(dev,test);
//判断是否处在自己设定的环境当中
boolean swaggerEnabled environment.acceptsProfiles(profiles);
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(com.example.swagger_demo.controller))//按包扫描,
.paths(PathSelectors.any())
.build()
.groupName(jf3q)
.enable(swaggerEnabled);
}作业
1.把掌上游戏app项目改成springboot项目mybatis部分先不用动并集成swagger生成在线接口文档已经就包含了本章所有内容 2.练习thymeleaf小案例
