美文网首页服务端
全栈开发探索 - Java 服务端

全栈开发探索 - Java 服务端

作者: Hi川 | 来源:发表于2019-05-28 22:31 被阅读14次

    服务端的技术选型

    服务端使用 Java 编写,用 maven 作为包管理工具,基于 SpringBoot 2.0.4,SpringBoot 的出现对于 Java Web 开发人员太友好,大大简化开发,省去很多配置,依赖变得很简洁。SpringBoot Starter 将应用所需的各种依赖聚合成一项依赖,如 一项 spring-boot-starter-web 依赖,相当于 spring-boot-starter, spring-boot-starter-tomcat, jackson-databind, spring-web, spring-webmvc 这几个依赖的总和。可以想到使用 starter 依赖,pom 文件看起来会简洁很多。

    Spring Boot 的自动配置功能则削减了 Spring 配置的数量,Sping Boot 会考虑应用中的其他因素并推断你所需要的 Spring 配置。如 Spring Boot 如果发现类路径下有 Spring MVC,它就会自动配置 Spring MVC 的多个 bean,如视图解析器,资源处理器,消息转换器等,我们只需要编写处理请求的控制器就可以。这让开发人员将精力只关注在业务开发上,大大提高开发效率。

    所以毋庸置疑开发新项目,Spring Boot 是首选。

    一个后台项目一定会连接数据库,数据库我使用 mysql 5.7,主要是因为 mysql 免费,使用广泛,开发环境建议使用 Docker 容器启动 mysql,使用容器可以很方便的安装数据库,节省时间。

    ORM 框架使用 MyBatis,MyBatis 的结果集映射功能强大,使用简单且灵活。部分查询功能涉及数据的分页,使用三方库 PageHelper 做分页。

    身份鉴权,权限控制,安全框架我使用 Shiro,该框架轻量,接口简单又功能强大。

    微信推送涉及调用其他内部系统接口,所以还需要使用 Netty 进行 TCP 通信。

    我还引入了一个 spring-boot-starter-aop 库,用于控制器的日志打印。

    以下就是我项目的 pom 文件内容:

    <?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">
        <modelVersion>4.0.0</modelVersion>
        <groupId>com.bots.itoa</groupId>
        <artifactId>EventCommand</artifactId>
        <version>0.0.9-SNAPSHOT</version>
        <packaging>jar</packaging>
        <name>EventCommand</name>
        <description>EventCommand project for Bots</description>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.0.4.RELEASE</version>
            <relativePath /> <!-- lookup parent from repository -->
        </parent>
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <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-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <optional>true</optional>
            </dependency>
            <!-- Mysql -->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
            </dependency>
            <!-- MyBatis -->
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.2</version>
            </dependency>
            <!-- Shiro -->
            <dependency>
                <groupId>org.apache.shiro</groupId>
                <artifactId>shiro-spring</artifactId>
                <version>1.4.0</version>
            </dependency>
            <!--PageHelper -->
            <dependency>
                <groupId>com.github.pagehelper</groupId>
                <artifactId>pagehelper-spring-boot-starter</artifactId>
                <version>1.2.3</version>
            </dependency>
            <!-- AOP -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-aop</artifactId>
            </dependency>
            <!-- netty -->
            <dependency>
                <groupId>io.netty</groupId>
                <artifactId>netty-all</artifactId>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.4</version>
                <scope>provided</scope>
            </dependency>
        </dependencies>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <configuration>
                        <fork>true</fork>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    </project>
    

    通常项目都是保存文件后自动编译,我们添加好依赖后保存一下 pom 文件,IDE 就会去 maven 中心库下载相应的 jar 包,但是有时候编译完,pom 文件提示报错,我们就要看下提示信息,是具体哪个包 miss 或有其他错误,去 maven 本地仓库找到对应的包查看是否下载好,如果没有下载好则最好删除对应的包文件夹,重新保存下 pom 文件重新编译下载 jar 包,如果我们的 jar 包反复下载不下来,则需要检查网络或可以去 maven 的 setting.xml 配置文件中配置阿里云的镜像地址。

    项目目录结构

    目录结构截图如下:

    目录结构.png

    主包 com.bots.itoa.EventCommand 下是项目的启动文件 EventCommandApplication.java ,其他所有的文件,文件夹都在该包下。如果配置类,组件类不在该包下,会发生无法自动注入的问题,因为 EventCommandApplication 类的 @SpringBootApplication 注解中开启了自动扫描,扫描的正是 com.bots.itoa.EventCommand 这个包。不在这个包下我们需要显式声明自动扫描注解,并指定扫描哪个包。

    base.bean 包下放了一些常用的基础 bean,有对响应结果的封装(状态码,结果信息,数据等),对分页的封装等。configuration 下放的是一些配置文件,如 ShiroConfig 是 Shiro 的配置文件,定义 ShiroFilterFactoryBean 具体路由对应的权限等。controller 中是各个业务模块的 controller 文件,定义业务端点,也就是对客户端暴露的接口,如 /login POST 就是项目的登录接口,用于鉴权用户身份。

    /login 示例代码:

    public ResultInfo<Object> login(@RequestBody Map<String, String> params) throws BusinessException {
       String username = params.get("username");
       String password = params.get("password");
       if (username == null || username.isEmpty()) {
          throw new BusinessException("用户名不能为空!");
       }
       if (password == null || password.isEmpty()) {
          throw new BusinessException("密码不能为空!");
       }
       UsernamePasswordToken token = new UsernamePasswordToken(username, password);
       Subject currentSubject = SecurityUtils.getSubject();
       String msg = "未知错误";
       try {
          logger.info("对用户[" + username + "]进行登录验证..验证开始");
          currentSubject.login(token);
          if (currentSubject.isAuthenticated()) {
             UserEntity userInfo = userService.getUser(currentSubject.getPrincipal().toString());
             return ResultInfo.Success(userInfo);
          } else {
             msg = "登录失败";
          }
       } catch (UnknownAccountException uae) {
          msg = "用户名错误";
       } catch (IncorrectCredentialsException ice) {
          msg = "密码错误";
       } catch (LockedAccountException lae) {
          msg = "账户已锁定";
       } catch (ExcessiveAttemptsException eae) {
          msg = "尝试次数过多";
       } catch (AuthenticationException ae) {
          msg = "用户名/密码不正确";
       }
       token.clear();
       return ResultInfo.Error(msg);
    }
    

    dao 中是 mabatis 的 mapper 接口文件,这些接口方法定义数据库的增删改查操作,方法名会和 mapper.xml 配置文件中的数据库操作 id 一一对应。

    mapper 接口代码示例:

    public interface MessageMapper {
       @Insert({"insert into message (title, description, create_user_id) values (#{title},#{description},#{createUser.id})"})
       @Options(useGeneratedKeys = true, keyProperty="id")
       void insertMessage(Message message);
       @Delete({"delete from message where message_id = #{id}"})
       void deleteMessageById(Integer id);
       @Update({"update message set title=#{title},description = #{description} where message_id = #{id}"})
       void updateMessage(Message message);
       @Select({"select count(1) from user_message where user_user_id = #{userId} and isRead = 0"})
       Integer countUnread(Integer userId);
       List<Message> selectMessageByContent(String content);
       Message selectMessageById(Integer id);
       List<Message> selectAllMessage();
    }
    

    domain 中就是业务的实体,如 Message 实体,定义消息的各个属性,如标题 titile,内容 description 等。

    示例代码:

    @Data
    public class Message {
       @JsonView(value = View.Summary.class)
       private Integer id;
       @JsonView(value = View.Summary.class)
       @NotBlank(message="{message.title.notBlank}")
       @Length(min = 1, max = 100, message = "{message.title.length}")
       private String title;
       @JsonView(value = View.Summary.class)
       @NotBlank(message="{message.description.notBlank}")
       @Length(min = 1, max = 300, message = "{message.description.length}")
       private String description;
       // 0 未读 1 已读
       @JsonView(value = View.Summary.class)
       private Integer isRead;
       private List<Integer> targetUserIds;
       @JsonView(value = View.Detail.class)
       private UserEntity createUser;
    }
    

    @Length@NotBlank 是一些字段的校验,会再 controller 中发挥作用。而 @JsonView 可以定义哪些数据作为响应返回,同样是在 controller 中发挥作用。

    service 中定义服务的接口和实现类,通常我们把功能分成服务模块,每个模块的功能定义一个接口文件,模块的功能对应接口的方法,然后创建实现类去实现这些接口。有时我们写一个功能会用到多个服务模块的功能。

    util 中是常用工具类,比如我的就包括一些异常处理,tcp 通信,日志打印,表格解析等等。

    resources 中存放程序的配置文件,程序的端口,数据库连接和一些三方库的配置等。里面还有 mybatis 的配置文件和mapper 配置文件。
    如图:

    resources.png

    因为 SpringBoot 内置了 Tomcat,所以我们直接运行 EventCommandApplication 这个入口文件就可以启动程序了。

    以上就是我这个项目的基础技术选型和项目结构,这些后端技术此前我从来没使用过,只能一个一个研究别无他法,从 SpringBoot,Maven,数据库,到一些三方类库的使用,从项目中实践,摸索是较好的学习方法。

    相关文章

      网友评论

        本文标题:全栈开发探索 - Java 服务端

        本文链接:https://www.haomeiwen.com/subject/uznktctx.html