3 Star 0 Fork 0

微乐云/Yuan-后台

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
MulanPSL-2.0

Spring-boot-starter-tool-model

Java Language, Spring Framework MulanPSL2

产品官网 | 下载地址 | 文档资源 | 体验环境


项目介绍

spring-boot-starter-tool-model后端

Spring-boot-starter-tool-moedl 是基于jdk 17,springframework 3.0.1的自动化实现数据增删改查的依赖。 可以使用极少的代码,实现数据对象的增删改查以及后台管理界面生成,让后端java开发者从繁琐的curd中解放双手,省去繁琐的前后端联调操作

如何使用

导入依赖

项目中已经包含了一个spring-boot项目的大部分必须依赖,因此只需要在项目中导入依赖代码即可

        <dependency>
            <groupId>cn.xisoil</groupId>
            <artifactId>spring-boot-starter-tool-model</artifactId>
            <version>1.1.3-RELEASE</version>
        </dependency>

如果项目需要lombok,您依旧需要导入lombok

       <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
        </dependency>

开启扫描

基于springboot,您需要在启动文件上标注以下注解,@EnableModel为本项目启动注解方法

@SpringBootApplication(scanBasePackages={"xx.xxx.*"})
@EnableModel
@EnableJpaAuditing
@EnableTransactionManagement
@EnableAsync
@EnableModel//开启注解

一些基本配置

在springboot的配置基础上,spring-boot-starter-tool-model新增了某些配置,它具有某些默认值,也可以忽略

yue:
    equipment: windows//可选值,linux/windows,意义不大,某些情况下的端口占用会依靠它来解决
    socketio://用于支付回调的socket信息,其他配置参考netty
        host: 0.0.0.0
        port: 9009
    auto:
        check: false//是否自动检查数据,项目首次启动需要开启此处,项目会做一些数据的初始化操作
        user://开启检查时会初始化管理员账户
            username: xxx
            password: xxx
        package:
            controller: xx.xx.xx//控制层代码生成位置
            persistent: xx.xx.xx//持久层代码生成位置

        

在完成以上配置后即可成功启动项目,访问地址:http://ip:port/admin,这样就完成了基本的项目配置,后台数据已经完成了初始化并且包含了一些基础的栏目

思想:约定大于配置

在自动生成的后台中接口调用中,我们已经做了某些约定。

  • 项目使用JPA作为持久层,分页查询基于pageable完成
  • 后端API一级目录为/manage

  • 接口规范(content-type:application/json)
    • 分页查询:post方法,路由/xxx/page
    • 不分页查询:get方法,路由/xxx/list
    • 添加数据:post方法,路由/xxx
    • 修改数据:put方法,路由/xxx
    • 获取数据:get方法,路由/xxx/{id}
    • 删除数据:post方法,路由/xxx/delete
    因此,你可以按照以上接口规范编写相关curd,后台可以获取到正确的数据

  • 你可以使用项目封装的抽象controller方法与repository快速的实现CURD。

    当我创建了一个实体类,只需要两个步骤就可以实现一个CURD

    • 持久层继承YueRepository
      public interface BasicInfoRepository extends YueRepository<BasicInfo,String> {
      
      }
      
    • 控制层继承SingleModelController或ModelCurdControllerMapping
      @RestController
      @RequestMapping("/manage/basicInfo")
      public class BasicController extends SingleModelController<BasicInfo, BasicInfoRepository> {
      }
    以上,一个完整的CURD就被实现了。

高阶操作:更好的实现CURD

以下是实体类注解

  • @CurdModelObject,标记实体类,描述类的相关信息
  • @CurdModel,标记类字段,描述字段信息
  • @CurdTrusteeShipObject,@CurdModelObject拓展使用,全自动生成CURD
为方便理解,下面展示了一个较为完整的类
@Data
@Entity(name = "Basic")
@Table(name = "BasicInfo")
//trusteeship不为空时会自动生成持久层与控制层,只需要一个实体类,就能自动实现增删改查
@CurdModelObject(name = "基本信息",trusteeship = @CurdTrusteeShipObject(auto = false))
@EntityListeners(AuditingEntityListener.class)
public class BasicInfo {

    @Id
    @GeneratedValue(generator="system-uuid")
    @GenericGenerator(name="system-uuid", strategy = "uuid")
    @Column(columnDefinition = "varchar(32)")
    private String id;

    //描述title
    @CurdModel(value = "网站主题")
    @NotBlank(message = "网站主题不能为空")
    private String title;

    //可以指定type
    @CurdModel(value = "ico图标",type = YueColumnsType.IMAGE)
    private String ico;

    @CurdModel(value = "logo1",type = YueColumnsType.IMAGE)
    private String logo;

    @CurdModel(value = "logo2",type = YueColumnsType.IMAGE)
    private String blogo;

    @CurdModel(value = "公司版权")
    private String company;

    @CurdModel(value = "版权所有")
    private String copyright;

    @CurdModel(value = "通知地址")
    private String email;

    @CurdModel(value = "seo-标题",type = YueColumnsType.TEXTAREA)
    private String tdkTitle;

    @CurdModel(value = "seo-描述",type = YueColumnsType.TEXTAREA)
    private String tdkRemark;

    @CurdModel(value = "seo-关键词",type = YueColumnsType.TEXTAREA)
    private String tdkKeywords;

    //富文本
    @CurdModel(value = "底部信息",type = YueColumnsType.RICHTEXT)
    @Lob
    private String footerInfo;


}

自带的数据统计

@VisitIntercept(clazz = xxxx.class,key = "sectionname")

@VisitIntercept标记的方法会进行栏目访问统计。

参数:

  • key: 优先级最高,不为空时记录key值作为栏目名称

  • clazz: YueAnalysisInterface的实现类,该方法包含了两个方法,getName(String) 与getName(),参数需要与args同时使用,使用该参数会通过调用getName方法获取sectionName,用户可自行编写逻辑获取sectionName

  • args: 入参序号,当用户访问地址xxx?id=xxx时,request入参中第一个字段为id,则args=1,如果key值为空,则通过key值获取对应参数,调用YueAnalysisInterface的实现类的getSectionName方法获取sectionName

计划任务

使用案例,通过TaskService此方法实现的定时任务可以直接通过后台管理

@Component
public class TaskUtils extends TaskService{


    public TaskUtils() {
        super("* * * * * ?");
    }


    @Override
    public String getTaskName() {
        return "计划任务-输出时间";
    }

    @Override
    public void run() {
        System.out.println(new Date().getTime());
    }
}

文件上传

我们新了一个模块专门用来实现文件上传,因此,你可以单独使用此模块实现文件上传,不过,spring-boot-starter-tool-model中已经包含了upload-model,如果你使用了tool-model,则无需重新引入

       //  文件上传组件 
        <dependency>
            <groupId>cn.xisoil</groupId>
            <artifactId>spring-boot-starter-upload-model</artifactId>
            <version>1.0.1-RELEASE</version>
        </dependency>

使用方法

创建服务


    //创建一个minio客户端
    MinioClient minioClient=UploadConfigClient
                .of(endpoint, bucketName, ak, sk)
                .minio()
    //创建一个OBS客户端
    ObsClient minioClient=UploadConfigClient
             .of(endpoint, bucketName, ak, sk)
             .obs()
    //创建一个OSS客户端
    OssClient minioClient=UploadConfigClient
             .of(endpoint, bucketName, ak, sk)
             .oss()
    

操作文件

    //以minio举例
    //上传
    minioClient.upload(FileInfo)
    //FileInfo 包含了文件信息,其中name字段必填,剩下字段任选其一
    
    //删除
    minioClient.delete(filename);
    
木兰宽松许可证, 第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.

About

Spring-boot-starter-tool-moedl Vue前端是基于Vue3的自动化实现数据增删改查的依赖。 可以使用极少的代码,实现数据对象的增删改查以及后台管理界面生成,让后端java开发者从繁琐的curd中解放双手,省去繁琐的前后端联调操作 expand collapse
NodeJS
MulanPSL-2.0
Cancel

Releases

No release

Contributors

All

Activities

Load More
can not load any more
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
NodeJS
1
https://gitee.com/mrengui/yuan_cms.git
git@gitee.com:mrengui/yuan_cms.git
mrengui
yuan_cms
Yuan-后台
master

Search