1 Star 0 Fork 0

张乐乐 / small-mvc-framework

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

small-mvc-framework

基于small-mvc-framework开发的个人博客项目

项目后端登录地址:http://akitten.host/small-myblog/page/login.html

前端博客地址:http://akitten.host/small-myblog/page/lele.html

介绍

快速开发框架,不须xml等文件配置即可使用,使开发人员更加专注于业务,基于注解的Aop切面编程与Ioc依赖注入,继承了mvc设计思想,适用于中小型项目,后续会继续完善

框架设计

模块设计

安装教程

  1. 暂时没有放入maven仓库中,如果想使用可在本页面下载jar包,导入maven即可,百度有教程请自行搜索,后续有空了会放maven仓库中
  2. 引入资源后在web.xml中配置Base拦截器即可,如下:
<!-- 核心拦截器,所有请求都会被拦截,并根据路由进行请求分发 -->
<servlet>
	<servlet-name>BaseInterceptor</servlet-name>
	<servlet-class>com.small.base.BaseInterceptor</servlet-class>
	<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
	<servlet-name>BaseInterceptor</servlet-name>
	<url-pattern>/*</url-pattern>
</servlet-mapping>
  1. 完成以上操作即可开发

使用教程

  1. 请求路径说明
    请求匹配规则,支持rest风格请求,所有请求会被拦截,动态请求会去匹配controller静态请求会被输出
$.ajax({
        url : "PlatformName/Demo/User/userLogin",
        async : false,
        type : 'POST',
        data : json
})
@Controller("Demo/User")
public class UserController {
    public void userLogin(Context context){
        ...
    }
}

说明:@Controller注解里的内容为"项目名/{content}/方法名"其中的content

  1. Aop使用说明
    摒弃了复杂的概念,减少学习成本,使用钩子方法实现增强
    (1):定义切面 切面需要继承AspectProxy 可以实现切面工厂类中的钩子方法,通知业务逻辑就写在钩子方法中
@Aspect
public class TestAspect extends AspectProxy {
  @Override
  public void before(Method method, Object[] params) throws Throwable {
    System.out.println("before");
  }
}

定义切面可使用的钩子方法有五种,开始增强begin()、前置增强before()、后置增强after()、异常增强error()以及最终增强end(),继承工厂类可自由选择需要使用的钩子方法,另外会有清除切面注解@Clear,使用它可以清除指定切面,以此达到个性化的使用

(2):定义切入点,在方法或者类上面使用@Pointcut注解,在其中传入切面类

@Pointcut({TestAspect.class})
public class UserController {

    @Pointcut({TestAspect2.class})
    void method1(){...}

    void method2(){...}

    @Clear({TestAspect.class})
    void method3(){...}
}

如上所述method1会被TestAspect、TestAspet2两个切面横切,method2会被TestAspect一个切面横切,method3将不会被切面横切,可以看出方法会继承类注解中的切面,而@Clear会清除指定切面类,实现Aop其根本是方法级别的

  1. Ioc注入
    (1)使用@Inject可以注入类和接口
    (2)注入接口需要传入指定实现类
    @Inject
    User user; //注入普通类

    @Inject(UserServiceImpl.class)
    IUserService userService;  //注入接口

如果在另一个类中使用了存在被横切方法的类则必须为这个类注入才可使用,也就是说必须交由Ioc容器管理

  1. GlobalAspect全局切面
    全局切面只对COntroller层有效,也就是说只有使用了@Controller注解的类才会被全局切面拦截,可用于token校验,系统级请求处理等
    使用方法:
    (1)定义类使用@GlobalAspect注解,在其中传入int数字,不允许出现重复值,全局切面的执行顺序和此数据有关
    (2)继承AspectProxy选择需要使用的钩子方法即可使用
    注:如个别Controller中的方法不需使用,比如校验token中的登录方法,登录方法不能进行token判断,这时可以使用@Clear清除指定切面拦截器
木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

快速开发框架,使开发人员更加专注于业务,基于注解的Aop切面编程与Ioc依赖注入,继承了mvc设计思想,适用于中小型项目,后续会继续完善 展开 收起
Java
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/karen_top/small-mvc-framework.git
git@gitee.com:karen_top/small-mvc-framework.git
karen_top
small-mvc-framework
small-mvc-framework
master

搜索帮助