1 Star 0 Fork 0

xxl / blog

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
AFL-3.0

blog项目说明

1:环境

  • IDEA2022.2.3
  • spring-boot 2.7.9
  • maven 3.8.6

2:项目中用到的框架/技术

  • 授权认证:jwt
  • jsr校验
  • 数据源(数据库连接池):druid
  • OPENAPI规范:swagger
  • 邮件
  • mybatis
  • mysql
  • 全局异常处理
  • AOP切面日志打印
  • 日志生成

3:blog API

  • swagger地址:具体的网址:8080/BlogApp/swagger
  • druid后台:具体的网址:8080/BlogApp/druid

4:项目的架构

  • 本项目用的是传统的三层架构,即MVC

  • 接下来是项目目录说明:-是文件夹 --是具体文件

    -src
        -main
            -com
                -xxl
                    -aop 打印全局异常和全局回应json到控制台
                    -config  mvc配置
                        --SpringWebMvcConfig.java  配置跨域和拦截器类
                    -controller 控制器
                        -impl  接口实现包
                        --AdminApi   管理员Api接口
                        --BlogApi 博客相关的接口
                        --BlogCommentApi 博客评论相关的额接口
                        --NoAuthenticationApi  不需要权限或者身份的接口
                        --UserApi  用户相关接口
                    -dao   数据库映射包,这个包下全是接口,具体实现由xxxMapper.xml实现
                        --blog
                            -BlogMapper  映射blog_database数据库中blog_content表
                            -CollectBlogMapper 映射blog_database数据库中collect_blog表
                            -HomBlogMapper 映射blog_database数据库中home_blog表
                        --comment
                            -BlogCommentMapper 映射blog_database数据库中blog_comment表
                        --follow
                            -FollowBlogMapper 映射blog_database数据库中follow_blog表
                        --user
                            -UserMapper 映射blog_database数据库中user_role、user_blog表
                    -dto javaBean
                    -exception  异常包处理全局异常
                    -filter 过滤器包,具体的权限过滤和等级过滤就是在这里实现的
                    -interceptor 拦截器包检查是否登录的
                    -service 业务包
                        - impl 接口实现包
                        --BlogService   映射博客相关的dto
                        --UserService    映射用户相关的dto
                    -util 工具包
                        --ConstantField    存放唯一不可变的值  java接口
                        --DateUtil     算法包,用于主页展示博客的算法Java类
                        --EmailUtil    生成注册码的java类
                        --GlobalResult   生成全局json回应的java类
                        --ModelData  存放全局唯一的变量java类
                        --UuidUtil  生成uuid的工具包java类
                    --BlogApplication 启动类
        -resources
            -config 存放mybatis配置文件
            -like  保存每位用户点赞记录的文件
            -mapper 存放mybatis的xxMapper.xml文件包,映射com.xxl.dao包下的各种接口
            -picture   存放用户上传头像的包注意在application.yml配置文件更改地址
            -sqlscript  sql脚本包,包下的文件直接运行就行,但是注意连接数据库
            --application.yml  主配置文件
            --application-database.yml 数据库配置文件
            --application-swagger.yml swagger文档的配置
            --log4j.properties 用于log4j的配置
        -test 测试目录不说明
    -.gitignore   忽略那些文件 
    -pom.xml  maven项目依赖文件
    -README.md readMe文件

5:总结

  • 开发新项目时
    1. 需要设计流程图

    2. 设置数据库

      • 数据主键千万不能是要改变的,本次最蠢的就是以用户以名字主键
      • A表和B表产生联系时一定需要不改变的主键用来联系,切不可用需要改变的字段
      • 前期一定要设计好,没有设计好后期一改动就会出现一些逻辑错误,而且还可能发生局部异常
    3. 编写后端

      • 第一点是一定需要确定安全、权限问题

      • 在编写某些服务时,如果涉及到某些联表的操作,就需要这个表的动作做完,另一个表也需要操作。如用户表和发布博客是连在一起的,如果要删除某一个用户时,就一定需要删除博客表的这个 用户所发的所有博客

      • 有些查询查询为空就返回空而不是返回查询失败

Academic Free License (“AFL”) v. 3.0 This Academic Free License (the "License") applies to any original work of authorship (the "Original Work") whose owner (the "Licensor") has placed the following licensing notice adjacent to the copyright notice for the Original Work: Licensed under the Academic Free License version 3.0 1) Grant of Copyright License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, for the duration of the copyright, to do the following: a) to reproduce the Original Work in copies, either alone or as part of a collective work; b) to translate, adapt, alter, transform, modify, or arrange the Original Work, thereby creating derivative works ("Derivative Works") based upon the Original Work; c) to distribute or communicate copies of the Original Work and Derivative Works to the public, under any license of your choice that does not contradict the terms and conditions, including Licensor’s reserved rights and remedies, in this Academic Free License; d) to perform the Original Work publicly; and e) to display the Original Work publicly. 2) Grant of Patent License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, under patent claims owned or controlled by the Licensor that are embodied in the Original Work as furnished by the Licensor, for the duration of the patents, to make, use, sell, offer for sale, have made, and import the Original Work and Derivative Works. 3) Grant of Source Code License. The term "Source Code" means the preferred form of the Original Work for making modifications to it and all available documentation describing how to modify the Original Work. Licensor agrees to provide a machine-readable copy of the Source Code of the Original Work along with each copy of the Original Work that Licensor distributes. Licensor reserves the right to satisfy this obligation by placing a machine-readable copy of the Source Code in an information repository reasonably calculated to permit inexpensive and convenient access by You for as long as Licensor continues to distribute the Original Work. 4) Exclusions From License Grant. Neither the names of Licensor, nor the names of any contributors to the Original Work, nor any of their trademarks or service marks, may be used to endorse or promote products derived from this Original Work without express prior permission of the Licensor. Except as expressly stated herein, nothing in this License grants any license to Licensor’s trademarks, copyrights, patents, trade secrets or any other intellectual property. No patent license is granted to make, use, sell, offer for sale, have made, or import embodiments of any patent claims other than the licensed claims defined in Section 2. No license is granted to the trademarks of Licensor even if such marks are included in the Original Work. Nothing in this License shall be interpreted to prohibit Licensor from licensing under terms different from this License any Original Work that Licensor otherwise would have a right to license. 5) External Deployment. The term "External Deployment" means the use, distribution, or communication of the Original Work or Derivative Works in any way such that the Original Work or Derivative Works may be used by anyone other than You, whether those works are distributed or communicated to those persons or made available as an application intended for use over a network. As an express condition for the grants of license hereunder, You must treat any External Deployment by You of the Original Work or a Derivative Work as a distribution under section 1(c). 6) Attribution Rights. You must retain, in the Source Code of any Derivative Works that You create, all copyright, patent, or trademark notices from the Source Code of the Original Work, as well as any notices of licensing and any descriptive text identified therein as an "Attribution Notice." You must cause the Source Code for any Derivative Works that You create to carry a prominent Attribution Notice reasonably calculated to inform recipients that You have modified the Original Work. 7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that the copyright in and to the Original Work and the patent rights granted herein by Licensor are owned by the Licensor or are sublicensed to You under the terms of this License with the permission of the contributor(s) of those copyrights and patent rights. Except as expressly stated in the immediately preceding sentence, the Original Work is provided under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or implied, including, without limitation, the warranties of non-infringement, merchantability or fitness for a particular purpose. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential part of this License. No license to the Original Work is granted by this License except under this disclaimer. 8) Limitation of Liability. Under no circumstances and under no legal theory, whether in tort (including negligence), contract, or otherwise, shall the Licensor be liable to anyone for any indirect, special, incidental, or consequential damages of any character arising as a result of this License or the use of the Original Work including, without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses. This limitation of liability shall not apply to the extent applicable law prohibits such limitation. 9) Acceptance and Termination. If, at any time, You expressly assented to this License, that assent indicates your clear and irrevocable acceptance of this License and all of its terms and conditions. If You distribute or communicate copies of the Original Work or a Derivative Work, You must make a reasonable effort under the circumstances to obtain the express assent of recipients to the terms of this License. This License conditions your rights to undertake the activities listed in Section 1, including your right to create Derivative Works based upon the Original Work, and doing so without honoring these terms and conditions is prohibited by copyright law and international treaty. Nothing in this License is intended to affect copyright exceptions and limitations (including “fair use” or “fair dealing”). This License shall terminate immediately and You may no longer exercise any of the rights granted to You by this License upon your failure to honor the conditions in Section 1(c). 10) Termination for Patent Action. This License shall terminate automatically and You may no longer exercise any of the rights granted to You by this License as of the date You commence an action, including a cross-claim or counterclaim, against Licensor or any licensee alleging that the Original Work infringes a patent. This termination provision shall not apply for an action alleging patent infringement by combinations of the Original Work with other software or hardware. 11) Jurisdiction, Venue and Governing Law. Any action or suit relating to this License may be brought only in the courts of a jurisdiction wherein the Licensor resides or in which Licensor conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any use of the Original Work outside the scope of this License or after its termination shall be subject to the requirements and penalties of copyright or patent law in the appropriate jurisdiction. This section shall survive the termination of this License. 12) Attorneys’ Fees. In any action to enforce the terms of this License or seeking damages relating thereto, the prevailing party shall be entitled to recover its costs and expenses, including, without limitation, reasonable attorneys' fees and costs incurred in connection with such action, including any appeal of such action. This section shall survive the termination of this License. 13) Miscellaneous. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. 14) Definition of "You" in This License. "You" throughout this License, whether in upper or lower case, means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with you. For purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. 15) Right to Use. You may use the Original Work in all ways not otherwise restricted or conditioned by this License or by law, and Licensor promises not to interfere with or be responsible for such uses by You. 16) Modification of This License. This License is Copyright © 2005 Lawrence Rosen. Permission is granted to copy, distribute, or communicate this License without modification. Nothing in this License permits You to modify this License as applied to the Original Work or to Derivative Works. However, You may modify the text of this License and copy, distribute or communicate your modified version (the "Modified License") and apply it to other original works of authorship subject to the following conditions: (i) You may not indicate in any way that your Modified License is the "Academic Free License" or "AFL" and you may not use those names in the name of your Modified License; (ii) You must replace the notice specified in the first paragraph above with the notice "Licensed under <insert your license name here>" or with a notice of your own that is not confusingly similar to the notice in this License; and (iii) You may not claim that your original works are open source software unless your Modified License has been approved by Open Source Initiative (OSI) and You comply with its license review and certification process.

简介

有spring boot搭建的blog后端系统API,具体说明请查看README文件 展开 收起
Java
AFL-3.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/com_xxl/blog.git
git@gitee.com:com_xxl/blog.git
com_xxl
blog
blog
master

搜索帮助