SpringBoot 入门配置篇(二)

上一篇学习了SpringBoot的一些基本必学用法,这一篇来学习一下SpringBoot相关配置。

前言

本篇文章的主要内容:

  • 配置Https
  • 配置拦截器
  • 配置页面转向
  • 配置资源指向
  • 配置favicon.ico
  • 配置banner

配置Https

  1. 生成证书

通过keytool命令来生成,如果提示命令不存在,需要配置java环境变量,然后根据提示输入秘钥口令和相关信息,最后会得到一个keystore.p12文件,把它复制到项目resources目录下。

keytool -genkey -alias tomcat -storetype PKCS12 -keyalg RSA -keysize 2048 -keystore keystore.p12 -validity 3650

命令中-alias设置别名,-storetype 设置证书格式,-keyalg设置加密算法,-keysize设置证书大小,-keystore设置证书文件地址,-validity设置有效天数。

  1. 配置application.yml
server:
  port: 8443
  ssl:
    key-store: classpath:keystore.p12
    key-store-password: 123456
    key-store-type: PKCS12
    key-alias: tomcat
    enabled: true

修改port为8443,添加ssl里面信息就填我们刚才命令设置的

  1. 添加ConnectorConfig.java
@Configuration
public class ConnectorConfig {
    @Bean
    public ServletWebServerFactory servletContainer() {
        TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory() {
            @Override
            protected void postProcessContext(Context context) {
                SecurityConstraint securityConstraint = new SecurityConstraint();
                securityConstraint.setUserConstraint("CONFIDENTIAL");
                SecurityCollection collection = new SecurityCollection();
                collection.addPattern("/*");
                securityConstraint.addCollection(collection);
                context.addConstraint(securityConstraint);
            }
        };
        tomcat.addAdditionalTomcatConnectors(getHttpConnector());
        return tomcat;
    }

    private Connector getHttpConnector() {
        Connector connector = new Connector("org.apache.coyote.http11.Http11NioProtocol");
        connector.setScheme("http");
        connector.setPort(8088);
        connector.setSecure(false);
        connector.setRedirectPort(8443);
        return connector;
    }
}

创建ConnectorConfig.java配置文件到config目录下并复制以上代码。代码collection.addPattern("/*")设置所有路径都配置https,如果只想设置/users下的路径配置https,只需要改/*/users/*即可。

以上就是配置https的相关步骤,很简单吧。

配置拦截器

配置拦截器有很多用途,这里就举一个最常见的例子。我们在浏览网页的时候,如果未登录,就会自动跳转到登录界面,下面我们通过Api接口来简单的实现一下这个功能。

  1. 添加SessionInterceptor拦截器
@Component("sessionInterceptor")
public class SessionInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("SessionInterceptor preHandle");
        HttpSession session = request.getSession(false);
        if (session != null && session.getAttribute("user") != null) {
            return true;
        } else {
            PrintWriter printWriter = response.getWriter();
            printWriter.write("{code: 501, message:\"not login!\"}");
            return false;
        }
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("SessionInterceptor postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("SessionInterceptor afterCompletion");
    }

}

preHandle()该方法将在请求处理之前进行调用,返回true会执行下一个Interceptor,返回false则不会执行下一个Interceptor也不会执行Controller里的方法,先声明的Interceptor的preHandle方法会先执行。这里去获取session中user的信息,如果存在则不拦截,否则输出501错误。

postHandle()该方法将在当前请求进行处理之后调用,且preHandle方法返回为true,先声明的Interceptor的postHandle方法会后执行

afterCompletion()该方法将在请求完成之后调用,同样且需要preHandle方法返回为true,一般用于进行资源清理

  1. 添加WebMvcConfig
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Autowired
    private SessionInterceptor sessionInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(sessionInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns("/user/register", "/user/login", "/error");
    }
}

addPathPatterns("/**")设置拦截所有路径地址。

excludePathPatterns()设置过滤不需要拦截的路径地址,这里配置了注册、登录和错误地址。

  1. 添加login接口

MyUserMapper.xml

<select id="login" resultMap="userMap">
    select * from user_t
    where username = #{userName} and password = #{password}
</select>

MyUserMapper.java, 因为注册接口没有做唯一限制,所有有可能查询多个,这里就用List来接收

List<MyUser> login(@Param("userName") String userName, @Param("password") String password);

MyUserServices.java

public List<MyUser> login(String userName, String password) {
    return userMapper.login(userName, password);
}

MyUserController.java

@RequestMapping(value = "/login", method = RequestMethod.GET)
public ResponseResult<MyUser> login(HttpServletRequest request, String userName, String password) {
    ResponseResult<MyUser> responseResult;
    try {
        List<MyUser> myUser = myUserServices.login(userName, password);
        if (myUser != null && myUser.size() > 0) {
            request.getSession(true).setAttribute("user", myUser.get(0));
            responseResult = new ResponseResult<>(200, "login success", myUser.get(0));
        } else {
            responseResult = new ResponseResult<>(501, "login failure: invalid userName or password", null);
        }
    } catch (Exception e) {
        e.printStackTrace();
        responseResult = new ResponseResult<>(501, "login failure: " + e.getMessage(), null);
    }
    return responseResult;
}

getSession(true)指的是如果不存在则会创建一个,存在则直接返回。登录成功后通过setAttribute设置user信息session,之后拦截器就能通过getAttribute("user")来获取到了。

至此,基本功能就已经实现了,当调用/user/login登录接口成功后,再去调用其它接口不会返回501提示,否则除"/user/register", "/user/login", "/error"这几个之外的接口都会提示501未登录提示!

配置页面转向

  1. 静态页面转向

很多时候我们需要在Controller中写类似下面的这样代码,没有业务逻辑,只有返回一个地址,通过浏览器访问 http://localhost:8088/hello 地址就能转向对应resources下静态页面路径下的hello.html页面了。

@RequestMapping("/hello")
public String test() {
    return "hello.html";
}

这样的功能可以在WebMvcConfig简单的配置实现,添加代码如下:

@Override
public void addViewControllers(ViewControllerRegistry registry) {
    registry.addViewController("/hello").setViewName("hello.html");
}
  1. 静态页面路径

优先级访问从高到低依次如下:

classpath:/META-INF/resources/
classpath:/resources/
classpath:/static/
classpath:/public/

上面classpath指的是与java文件夹同级的resources文件夹

  1. 动态页面转向

添加依赖包

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

添加了thymeleaf之后,通过浏览器访问 http://localhost:8088/hello 地址就会转向对应templates路径下的hello.html页面。同时可以省去后缀名.html

@Override
public void addViewControllers(ViewControllerRegistry registry) {
    registry.addViewController("/hello").setViewName("hello");
}
  1. 动态页面传值

添加index.html到templates文件夹下, 里面有一个name参数需要从controller中映射

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org" lang="en">
<head>
    <meta charset="UTF-8">
    <link th:src="@{bootstrap/css/bootstrap.min.css}" rel="stylesheet">
    <link th:src="@{bootstrap/css/bootstrap-theme.min.css}" rel="stylesheet">
    <title>Title</title>
</head>
<body>
<script th:src="@{jquery-1.10.2.min.js}" type="text/javascript"></script>
<script th:src="@{bootstrap/js/bootstrap.min.js}" ></script>
Hello <span th:text="${name}"></span>!
</body>
</html>

添加IndexController.java到controller文件夹, 通过Model对象来设置name的属性值

@Controller
public class IndexController {
    @RequestMapping("/index")
    public String hello(Model model) {
        model.addAttribute("name", "Soaic");
        return "index";
    }
}

最后在浏览器访问 http://localhost:8088/index 地址就能看到Hello Saoic!。

配置资源映射

如果想访问项目中的静态资源,除了把资源放到上面那些静态资源地址目录下,还可以通过配置来设置。只需要在WebMvcConfig中重写addResourceHandlers方法,代码如下:

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/images/**").addResourceLocations("classpath:/images/");
}

配置后通过地址 http://localhost:8088/images/xxx 就能访问resources/images/目录下的资源了

配置favicon.ico

  1. 设置favicon的开关

在application.yml中配置

spring:
  mvc:
    favicon:
      enabled: true
  1. 添加favicon.ico到默认静态资源目录

ico 制作的网上有很多,这里就不多说了。

  1. 在html文件中添加
<head>
    <link rel="shortcut icon" href="/static/favicon.ico" />
</head>

我这里是把favicon.ico放在static目录下了。有些浏览器第三步不用做,只要放进了静态资源目录就能显示显示出来。

配置banner

每次项目启动的时候,控制台会显示一个字符拼接的图形,显示这个图形的配置很简单。

制作一个banner.txt, 网上有很多可以找找,大家可以找找看,然后复制到resources资源根目录下,然后启动项目就能看到了。

                      _ooOoo_
                     o8888888o
                     88" . "88
                     (| ^_^ |)
                     O\  =  /O
                  ____/`---'\____
                .'  \\|     |  `.
               /  \\|||  :  |||  \
              /  _||||| -:- |||||-  \
              |   | \\\  -  / |   |
              | \_|  ''\---/''  |   |
              \  .-\__  `-`  ___/-. /
            ___`. .'  /--.--\  `. . ___
          ."" '<  `.___\_<|>_/___.'  >'"".
        | | :  `- \`.;`\ _ /`;.`/ - ` : | |
        \  \ `-.   \_ __\ /__ _/   .-` /  /
  ========`-.____`-.___\_____/___.-`____.-'=======
                       `=---='
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        佛祖保佑       永不宕机     永无BUG

上面是我在网上找的一个,大家可以拿去试试

以上就是本篇文章的全部内容,希望对大家有所帮助,下篇再见!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容