blog(1):项目搭建

于 2020-12-05 15:16:10 发布
阅读量399 收藏
点赞数
分类专栏： blog 文章标签： spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/weixin_42573746/article/details/110683350
版权

项目搭建

模块目录

在这里插入图片描述
模块之间依赖关系
blog-web --> blog-service —> blog-dal —> blog-common

mavn依赖

blog-web

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <artifactId>blog</artifactId>
        <groupId>com.wangyue</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <groupId>com.wangyue</groupId>
    <artifactId>blog-web</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>blog-web</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-security</artifactId>
        </dependency>

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

        <dependency>
            <groupId>com.wangyue</groupId>
            <artifactId>blog-service</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter</artifactId>
            <version>RELEASE</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

web层引入了web相关依赖，以及spring secutiry（权限控制方面只做简单测试，先不支持用户登录）。

blog-dal

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>blog</artifactId>
        <groupId>com.wangyue</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>blog-dal</artifactId>

    <dependencies>
        <!--mybatis-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.3</version>
        </dependency>

        <!--通用mapper-->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>2.1.5</version>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.21</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
    </dependencies>


</project>

dal模块引入了tk.mybatis，并使用druid数据源

配置

在web模块中，使用两个配置文件来区分测试和生产环境。
在这里插入图片描述
其中测试环境配置如下，生产和测试环境基本一致，只是要切换为生产环境的数据源

spring:
  profiles: fat
  aop:
    auto: true
    proxy-target-class: true
  datasource:
    url: jdbc:mysql://xxxx:3306/blog?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=UTC
    username: root
    password: xxxxxxx
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource

server:
  port: 8090
logging:
  level:
    root: info
    com:
      wangyue:
        mapper: debug
mybatis:
  type-aliases-package: com.wangyue.model

项目测试

下面我们来测试搭建的环境是否正常。
首先测试web层，编写一个测试controller，启动服务访问controller进行测试即可

package com.wangyue.controller;


import com.alibaba.fastjson.JSON;
import com.wangyue.annotation.ControllerLogAnnotation;
import com.wangyue.model.Log;
import com.wangyue.service.LogService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

/**
 * @author Wang Yue
 * @version 1.0
 * @description: TODO
 * @date 2020/12/2 0:00
 */

@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {

    @Autowired
    private LogService logService;

    @RequestMapping(value = "/hello",method = RequestMethod.GET)
    @ResponseBody
    public String hello() {
        return "hello spring security";
    }
}

使用aop进行日志记录

日志表创建以及service提供

使用aop进行日志记录，同时可以测试dal层是否正常，和数据库交互是否正常。
创建日志表

CREATE TABLE `t_log` (
	`id` BIGINT ( 20 ) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '主键',
	`uuid` VARCHAR(50) NOT NULL DEFAULT '' COMMENT '请求的唯一键',
	`method` VARCHAR ( 200 ) NOT NULL DEFAULT '' COMMENT '方法',
	`parameter` VARCHAR ( 100 ) NOT NULL DEFAULT '' COMMENT '请求参数',
	`method_message` VARCHAR(50) NOT NULL DEFAULT '' COMMENT '方法描述',
	`ip` VARCHAR ( 20 ) NOT NULL DEFAULT '' COMMENT '请求ip',
	`type` TINYINT NOT NULL DEFAULT 0 COMMENT '0:controller,1:service',
	`status` TINYINT NOT NULL DEFAULT 0 COMMENT '0:失败，1:成功',
	`status_code` VARCHAR(10) NOT NULL DEFAULT '' COMMENT '返回状态码',
	`message` VARCHAR(50) NOT NULL DEFAULT '' COMMENT '返回状态描述',
	`time` INT(5) NOT NULL DEFAULT 0 COMMENT '耗时',
	`gmt_create` TIMESTAMP DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
	`gmt_modified` TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
PRIMARY KEY ( `id` ) ,
UNIQUE KEY uk_uuid (`uuid`)
) ENGINE = INNODB DEFAULT CHARSET = utf8mb4 COMMENT = '日志记录表';

使用插件生成基本mapper，这里不再赘述
在这里插入图片描述
使用tk.mybatis可以大大减少sql编写量。
此时我们在controller中注入mapper就可以实现数据库操作，但是在实际开发中，往往在service层中注入mapper，在controller中注入service.
所以我们编写service，提供新增和根据唯一主键更新的方法。

package com.wangyue.service.impl;

import com.wangyue.mapper.LogMapper;
import com.wangyue.model.Log;
import com.wangyue.service.LogService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import tk.mybatis.mapper.weekend.Weekend;
import tk.mybatis.mapper.weekend.WeekendCriteria;

/**
 * @author Wang Yue
 * @version 1.0
 * @description: TODO
 * @date 2020/12/1 23:07
 */
@Service
public class LogServiceImpl implements LogService {

    @Autowired
    private LogMapper logMapper;


    @Override
    public void addLog(Log logger) {
        logMapper.insertSelective(logger);
    }

    @Override
    public void updateByUuid(Log logger) {
        Weekend<Log> weekend = new Weekend<>(Log.class);
        WeekendCriteria<Log, Object> weekendCriteria = weekend.weekendCriteria();
        weekendCriteria.andEqualTo(Log::getUuid, logger.getUuid());
        logMapper.updateByExampleSelective(logger, weekend);
    }
}

使用aop进行日志记录

自定义一个注解

package com.wangyue.annotation;

import java.lang.annotation.*;

/**
 * @description: controller日志注解
 * @author Wang Yue
 * @date: 2020/12/1 22:33
 */
@Target({ElementType.PARAMETER,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ControllerLogAnnotation {
    String description() default "";
}

配置切面和通知

package com.wangyue.aspect;

import com.alibaba.fastjson.JSON;
import com.wangyue.annotation.ControllerLogAnnotation;
import com.wangyue.model.Log;
import com.wangyue.service.LogService;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

/**
 * @author Wang Yue
 * @version 1.0
 * @description: TODO
 * @date 2020/12/1 22:36
 */
@Aspect
@Component
@Slf4j
public class SystemLogAspect {

    @Autowired
    private LogService logService;

    ThreadLocal<Map<String, String>> local = new ThreadLocal<>();

    //Controller层切点
    @Pointcut("@annotation(com.wangyue.annotation.ControllerLogAnnotation)")
    public void controllerAspect() {
    }

    @Before("controllerAspect()")
    public void doBefore(JoinPoint joinPoint) throws NoSuchMethodException {
        Signature signature = joinPoint.getSignature();
        MethodSignature msg=(MethodSignature) signature;
        Object target = joinPoint.getTarget();

        String uuid = UUID.randomUUID().toString().replaceAll("-", "");
        Map<String, String> localMap = new HashMap<>();
        localMap.put("UUID", uuid);
        localMap.put("startTime", String.valueOf(System.currentTimeMillis()));
        local.set(localMap);

        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();

        Log logger = new Log();

        Method method = target.getClass().getMethod(signature.getName(), msg.getParameterTypes());
        //获取注解
        ControllerLogAnnotation annotation = method.getAnnotation(ControllerLogAnnotation.class);
        Object[] args = joinPoint.getArgs();


        logger.setUuid(uuid);
        logger.setMethod(method.toString());
        logger.setParameter(JSON.toJSONString(args));
        logger.setIp(request.getRemoteAddr());
        logger.setType((byte) 1);
        logger.setMethodMessage(annotation.description());
        logService.addLog(logger);
    }

    @AfterReturning(returning = "result",pointcut = "controllerAspect()")
    public void doAfterReturn(Object result){
        log.info("接口返回报文:{}", JSON.toJSONString(result));
        Map<String, String> localMap = local.get();
        Log logger = new Log();
        logger.setUuid(localMap.get("UUID"));
        logger.setStatus((byte) 1);
        logger.setStatusCode("200");
        logger.setMessage("成功");
        logger.setTime(Integer.valueOf(String.valueOf(System.currentTimeMillis() - Long.valueOf(localMap.get("startTime")))));
        logService.updateByUuid(logger);
    }
}

在controller中使用自定义注解

    @ControllerLogAnnotation(description = "测试aop日志是否生效")
    @RequestMapping(value = "/test",method = RequestMethod.POST)
    @ResponseBody
    public String test(@RequestBody Log logger) {
        log.info("请求参数:{}", JSON.toJSONString(logger));
        return "test";
    }

启动应用访问测试接口，日志入库即可。
在这里插入图片描述

全局异常处理

package com.wangyue.handler;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;
import java.util.Map;

/**
 * @author Wang Yue
 * @version 1.0
 * @description: TODO
 * @date 2020/12/2 22:57
 */
@ControllerAdvice(basePackages = "com.wangyue.controller")
@Slf4j
public class GlobalExceptionHandler {

    @ExceptionHandler(RuntimeException.class)
    @ResponseBody
    public Map<String,Object> errorResult(){
        //注意：在实际的公司开发过程中，要把错误记录在日志中
        Map<String,Object> errorResultMap=new HashMap<String,Object>();
        errorResultMap.put("errorCode","1314520");
        errorResultMap.put("errorMsg","系统喜欢你到死机");
        return errorResultMap;
    }

}

这里只是一个简单实现，后面定义全局的返回数据对象之后，再优化这里。

引入spring-security

package com.wangyue.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

/**
 * @author Wang Yue
 * @version 1.0
 * @description: TODO
 * @date 2020/12/5 13:47
 */
@Configuration
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {

        http.cors();
        http.csrf().disable();
        http.authorizeRequests().antMatchers("/test/hello","/**").permitAll()
                .anyRequest().authenticated();
    }
}

你可以使用一个简单的controller进行spring-security的测试

@ControllerLogAnnotation(description = "hello spring security")
    @RequestMapping(value = "/hello",method = RequestMethod.GET)
    @ResponseBody
    public String hello() {
        return "hello spring security";
    }

你可以在WebSecurityConfig中设置此接口是否需要身份验证。大部分的blog项目，都不会强制用户登录，在其他功能完善之前，我也不会增加用户登录的一些功能。

等完善一些功能之后，可以回头来添加用户的一些登录控制（不强制登录，仅做学习使用）。

一些坑

  1. SpringBoot创项目启动报：无法访问org.springframework.context.ConfigurableApplicationContext
    引起这个错误的原因大多是因为注解使用不当引起，检查注解之后，并没有发现问题。
    通过刪除创建目录时自动生成的.iml文件，重新构建解决了该报错。

  2. spring-boot中Controller路径无法被访问的问题
    参考：https://www.cnblogs.com/remember-me/p/10091126.html
    重点：
    @SpringBootApplication 注解，等于 @SpringBootConfiguration+@EnableAutoConfiguration+@ComponentScan
    默认的扫描路径是启动类下的路径
    笔者报错的原因是自己写了@ComponentScan(basePackages = “”),basePackages中没有包含controller包
    只需要将自己写的@ComponentScan(basePackages = “”)去掉即可

  3. Mapper找不到的问题
    可以通过注解 @MapperScan(basePackages = “com.xxx.mapper”) 配置mapper的扫描路径

参考

需要了解spring-security可以参考一下博客
spring-security

评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值