在.NET Core类库中使用EF Core迁移数据库到SQL Server

  1. Spring
    Boot是由Pivotal团队提供的崭新框架,其设计目的是用来简化新Spring应用的先导搭建以及支出进程。该框架使用了一定的主意来举行配置,从而使开发人士不再需要定义样板化的安排。通过这种措施,Boot致力于在蓬勃发展的全速利用开发领域(rapid
       application  development)成为官员。
     可以 Maven | Gradle | Ant |
    Starters构建项目,参考:http://start.spring.io/ 可以挑选Maven或Gradle生成Demo,Spring
    boot微服务架构重组Docker容器运行。
      软件版本运行要求请参见官网: Spring boot官网  
    本实例软件版本:JDK1.7 + Spring boot 1.3.5 + Spring 4.2.6 

前言

设若我们刚使用EntityFramework
Core作为ORM框架的话,想必都会赶上数据库迁移的部分问题。

胚胎我是在ASP.NET
Core的Web项目中展开的,但新兴察觉位于这里并不是很有理,一些有关数据库的迁徙,比如新增表,字段,修改字段类型等等,不应有和最上层的Web项目所涉及,数据的动迁文件放到这里也感觉到有点多余,有点乱乱的感觉,所以才想着单独出来由专门的品类进展管理会相比好,也比较清晰!

注意目的框架选用的是.NET Core 2.0而不是.NET
Standard 2.0。

  常用的starter以及用处可以列举如下:

0、先前时期准备

a)、表实体定义,这多少个是在.NET
Standard 2.0的类库中存放的。

    /// <summary>
    /// 系统应用的用户实体
    /// </summary>
    public class ApplicationUser : BaseModel
    {
        /// <summary>
        /// 用户名
        /// </summary>
        public string UserName { get; set; }

        /// <summary>
        /// 密码
        /// </summary>
        public string Password { get; set; }

        /// <summary>
        /// 邮件地址
        /// </summary>
        public string Email { get; set; }
    }

b)、新建一个.NET Core
2.0的类库,并定义好大家所要使用的数据库上下文,很简短,接下去最先大家的正文

    /// <summary>
    /// 系统上下文
    /// </summary>
    public class LightContext : DbContext
    {
        public LightContext(DbContextOptions<LightContext> options) : base(options)
        {
        }

        /// <summary>
        /// 系统应用用户
        /// </summary>
        public DbSet<ApplicationUser> ApplicationUser { get; set; }

        /// <summary>
        /// 角色表
        /// </summary>
        public DbSet<Role> Role { get; set; }
    }

(1)spring-boot-starter: 这是着力Spring Boot
starter,提供了绝大多数基础意义,其他starter都依靠于它,由此没有必要显式定义它。

1、问题汇总

率先要保证仓储类库中早已引入以下多少个Nuget包,没有的话请使用包管理器举办设置。不指出直接引入原包:Microsoft.AspNetCore.All,按需引入即可

Install-Package Microsoft.EntityFrameworkCore.SqlServer

Install-Package Microsoft.EntityFrameworkCore.Tools

a)打开CMD,然后切换来类库所在路径下,执行以下命令。不过你也得以动用程序包管理器控制台(PMC)举办搬迁,但是会有个别变化,部分命令见下表:

迁移命令描述 CMD命令 PMC命令
创建迁移:migrationname为迁移名称 dotnet ef migrations add migrationname add-migration migrationname
移除迁移(删除最近的一次迁移) dotnet ef migrations remove remove-migration
应用最新的迁移(使迁移文件应用到数据库) dotnet ef database update update-database
应用指定的迁移 dotnet ef database update migrationname update-database migrationname
查看迁移列表 dotnet ef migrations list  
查看数据库上下文信息 dotnet ef dbcontext info  
dotnet ef

图片 1

张冠李戴指示:

  未找到与命令“dotnet-ef”匹配的可执行文件

解决方法:

  在项目文件Light.Repository.csproj中添加以下节点

<ItemGroup>
    <DotNetCliToolReference Include="Microsoft.EntityFrameworkCore.Tools.DotNet" Version="2.0.1" />
</ItemGroup>

再也履行下面的下令,假设出现了EF
Core的注脚(一头蓄势待发的野马)表示曾经打响

图片 2

 b)、执行以下命令进行搬迁

dotnet ef migrations add InitLightDB

图片 3

荒谬指示:

The specified framework version ‘2.0’ could
not be parsed
The specified framework
‘Microsoft.NETCore.App’, version ‘2.0’ was not found.

  • Check application dependencies and
    target a framework version installed at:
    \
  • Alternatively, install the framework
    version ‘2.0’.

釜底抽薪措施:

  在档次文件中添加以下节点:

  <PropertyGroup>
    <TargetFramework>netcoreapp2.0</TargetFramework>
    <RuntimeFrameworkVersion>2.0.3</RuntimeFrameworkVersion>
  </PropertyGroup>

c)、重新履行b步骤的指令,报错音信如下:

图片 4

张冠李戴提醒:

  Unable to create an object of type
‘LightContext’. Add an implementation of
‘IDesignTimeDbContextFactory<LightContext>’ to the project, or see
https://go.microsoft.com/fwlink/?linkid=851728 for additional patterns
supported at design time.

以此问题即便是在Web项目,并且安排了DbContext的链接字符串的话,是不会冒出此题材的。很显然是迁移命令没有找到DbConnectionString导致的,接下去咱们按照指示,实现一个IDesign提姆(Tim)eDbContextFactory<LightContext>试试

解决方法:

  创制一个与DbContext同一目录下的Design提姆eDbContextFactory文件,然后实现接口中的方法CreateDbContext,并配备ConnectionString

   public class DesignTimeDbContextFactory : IDesignTimeDbContextFactory<LightContext>
    {
        public LightContext CreateDbContext(string[] args)
        {
            var builder = new DbContextOptionsBuilder<LightContext>();
            builder.UseSqlServer("Server=(localdb)\\MSSQLLocalDB;Integrated Security=true;Initial Catalog=Light;");
            return new LightContext(builder.Options);
        }
    }

 再度实施迁移命令,终于成功了。

图片 5

马到成功唤醒:

  Done. To undo this action, use ‘ef
migrations remove’

再就是类库下边会生成Migrations文件夹以及有关的搬迁文件

图片 6

(2)spring-boot-starter-actuator:紧要提供监督、管理和查处应用程序的功能。

2、小试迁移命令

a)、使用以下命令应用迁移,生成数据库和表

dotnet ef database update

图片 7

透过VS的SQL
Server资源管理器查看生成数据库的组织,其中__EFMigrationsHistory为每一趟迁移的记录表

图片 8

b)、因为string类型的字段迁移到数据库之后的数据类型为nvarchar(max)并且是可空类型的,下面我们就采纳Fluent
API对ApplicationUser表字段进展配备,同样你也得以拔取性能阐明的法门展开安排,因为自己要好不喜欢“污染”表实体

    public static void ConfigApplicationUser(ModelBuilder modelBuilder)
        {
            modelBuilder.Entity<ApplicationUser>(m =>
            {
                m.Property(t => t.Email)
                        .HasMaxLength(50);

                m.Property(t => t.UserName)
                        .IsRequired()
                        .HasMaxLength(50);

                m.Property(t => t.Password)
                        .IsRequired()
                        .HasMaxLength(20);
            });
        }

然后同样接纳方面的两条命令重新迁移并更新数据库结构

图片 9

观测数据库表结构早已更新

图片 10

 同理添加字段,删除字段都是一模一样的迁移操作,如故很方便的

(3)spring-boot-starter-jdbc:该starter提供对JDBC操作的支撑,包括连续数据库、操作数据库,以及管理数据库连接等等。

3、扩展

a)、为了有利于演示,其实下面在类库中实施迁移时的数据库连接字符串是写死的,那么最好的法门是应有去读取Web项目下已经配备好的接连,这样就能担保上下的一致性,不用再去为了EF的迁移而独自维护一个剩余的数据库连接配置。改造也很简短,即经过Configuration组件读取appsettings.json的ConnectionStrings节点,改造之后是这样子的:

    public class DesignTimeDbContextFactory : IDesignTimeDbContextFactory<LightContext>
    {
        public LightContext CreateDbContext(string[] args)
        {
            Directory.SetCurrentDirectory("..");//设置当前路径为当前解决方案的路径
            string appSettingBasePath = Directory.GetCurrentDirectory() + "/Light.AuthorityApi";//改成你的appsettings.json所在的项目名称
            var configBuilder = new ConfigurationBuilder()
                .SetBasePath(appSettingBasePath)
                .AddJsonFile("appsettings.json")
                .Build();

            var builder = new DbContextOptionsBuilder<LightContext>();
            //builder.UseSqlServer("Server=(localdb)\\MSSQLLocalDB;Integrated Security=true;Initial Catalog=Light;");
            builder.UseSqlServer(configBuilder.GetConnectionString("LightConnection"));
            return new LightContext(builder.Options);
        }
    }

瞩目需要额外引入下边这么些Nuget包:

Install-Package Microsoft.Extensions.Configuration.Json

b)、属性声明[Column(Order = 1)]对EF
Core来说还不曾达标能够调整数据库生成字段的相继,然则我们还是可以够修改迁移文件的实业性质的一一来达成我们想要的效用。上边是本人调动未来重新生成的表,是不是看出来和上边的有哪些不同,一图胜万语:

图片 11

 c)、最终一步,自己出手试试看:创立一个SeedData迁移文件来添加数据库的起首数据。:)

(4)spring-boot-starter-data-jpa:JPA starter提供使用Java Persistence
API(例如Hibernate等)的依赖库。

4、最后

EF
Core的强大远不止这多少个,还有更多的采取办法等着我们去发现,去琢磨。天天提升一点点,是件很快乐的事务!

(5)spring-boot-starter-data-*:提供对MongoDB、Data-Rest或者Solr的支持。

(6)spring-boot-starter-security:提供具有Spring-security的依赖库。

(7)spring-boot-starter-test:这么些starter包括了spring-test看重以及此外测试框架,例如JUnit和Mockito等等。

(8)spring-boot-starter-web:该starter包括web应用程序的倚重库。

2.Maven构建项目pom代码

  1 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3     <modelVersion>4.0.0</modelVersion>
  4 
  5     <groupId>ygnet</groupId>
  6     <artifactId>boot</artifactId>
  7     <version>0.0.1-SNAPSHOT</version>
  8     <packaging>jar</packaging>
  9 
 10     <name>Springboot</name>
 11     <url>http://maven.apache.org</url>
 12     
 13     <properties>
 14         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 15         <java.version>1.7</java.version>
 16     </properties>
 17     
 18     <!-- Spring Boot 启动父依赖 -->
 19     <parent>
 20         <groupId>org.springframework.boot</groupId>
 21         <artifactId>spring-boot-starter-parent</artifactId>
 22         <version>1.3.5.RELEASE</version>
 23         <relativePath />
 24     </parent>
 25     <dependencies>
 26         <dependency>
 27             <groupId>junit</groupId>
 28             <artifactId>junit</artifactId>
 29             <version>4.12</version>
 30             <scope>test</scope>
 31         </dependency>
 32         <dependency>
 33           <groupId>org.springframework</groupId>
 34           <artifactId>spring-test</artifactId>
 35           <version>4.2.6.RELEASE</version>
 36         </dependency>
 37             
 38         <!-- Spring Boot web依赖 -->
 39         <dependency>
 40             <groupId>org.springframework.boot</groupId>
 41             <artifactId>spring-boot-starter-web</artifactId>
 42         </dependency>
 43         <dependency>
 44             <groupId>org.springframework.boot</groupId>
 45             <artifactId>spring-boot-starter</artifactId>
 46         </dependency>    
 47         <!--dependency>
 48             <groupId>org.springframework.boot</groupId>
 49             <artifactId>spring-boot-starter-test</artifactId>
 50             <scope>test</scope>
 51         </dependency-->
 52         <dependency>
 53             <groupId>org.springframework.boot</groupId>
 54             <artifactId>spring-boot-starter-jdbc</artifactId>
 55         </dependency>
 56         <dependency>
 57             <groupId>org.postgresql</groupId>
 58             <artifactId>postgresql</artifactId><scope>runtime</scope>
 59         </dependency>
 60         <dependency>
 61             <groupId>org.springframework.boot</groupId>
 62             <artifactId>spring-boot-starter-actuator</artifactId>
 63         </dependency>
 64     </dependencies>
 65     <build>
 66         <pluginManagement>  
 67             <plugins>  
 68               <plugin>  
 69                 <groupId>org.eclipse.m2e</groupId>  
 70                 <artifactId>lifecycle-mapping</artifactId>  
 71                 <version>1.0.0</version>  
 72                 <configuration>  
 73                   <lifecycleMappingMetadata>  
 74                     <pluginExecutions>  
 75                       <pluginExecution>  
 76                         <pluginExecutionFilter>  
 77                           <groupId>org.apache.maven.plugins</groupId>  
 78                           <artifactId>maven-dependency-plugin</artifactId>  
 79                           <versionRange>[2.0,)</versionRange>  
 80                           <goals>  
 81                             <goal>copy-dependencies</goal>  
 82                           </goals>  
 83                         </pluginExecutionFilter>  
 84                         <action>  
 85                           <ignore />  
 86                         </action>  
 87                       </pluginExecution>  
 88                     </pluginExecutions>  
 89                   </lifecycleMappingMetadata>  
 90                 </configuration>  
 91               </plugin>  
 92             </plugins>  
 93         </pluginManagement>
 94         <plugins>
 95             <!-- 打Jar包(META-INF) -->
 96             <plugin>
 97                 <groupId>org.apache.maven.plugins</groupId>  
 98                 <artifactId>maven-jar-plugin</artifactId>  
 99                 <configuration>  
100                     <archive>  
101                         <manifest>  
102                            <addClasspath>true</addClasspath>  
103                            <classpathPrefix>lib/</classpathPrefix>  
104                            <mainClass>yg.boot.App</mainClass>  
105                         </manifest>  
106                     </archive>  
107                 </configuration>  
108             </plugin>
109             <!-- 项目资源文件 -->
110             <plugin>  
111                 <groupId>org.apache.maven.plugins</groupId>  
112                 <artifactId>maven-resources-plugin</artifactId>  
113                 <version>2.5</version>  
114                 <executions>  
115                     <execution>  
116                         <phase>compile</phase>  
117                     </execution>  
118                 </executions>  
119                 <configuration>  
120                     <encoding>${project.build.sourceEncoding}</encoding>  
121                 </configuration>  
122             </plugin>
123             <!-- 是否启动测试 -->
124             <plugin>
125                 <groupId>org.apache.maven.plugins</groupId>  
126                 <artifactId>maven-surefire-plugin</artifactId>
127                 <version>2.17</version> 
128                 <configuration>
129                   <skipTests>true</skipTests>  
130                 </configuration>
131             </plugin>
132             <!-- 复制依赖包到项目lib文件夹下 -->
133             <plugin>  
134                 <groupId>org.apache.maven.plugins</groupId>  
135                 <artifactId>maven-dependency-plugin</artifactId>  
136                 <version>2.8</version>  
137                 <executions>  
138                     <execution>  
139                         <phase>package</phase>  
140                         <goals>  
141                             <goal>copy-dependencies</goal>  
142                         </goals>  
143                     </execution>  
144                 </executions>
145                 <configuration>
146                     <outputDirectory>${project.basedir}/lib</outputDirectory>
147                     <includeScope>compile</includeScope>  
148                 </configuration>  
149             </plugin>
150             <!-- Spring boot 打包 -->
151             <plugin>
152                 <groupId>org.springframework.boot</groupId>
153                 <artifactId>spring-boot-maven-plugin</artifactId>
154             </plugin>
155         </plugins>
156     </build>
157 </project>

3.Controller

Spring
Boot框架提供的建制便于工程师实现规范的RESTful接口,编写Controller代码,首先咱们要在pom文件中加上对应的starter,即spring-boot-starter-web,对应的xml代码示例为:
<dependency> 
<groupId>org.springframework.boot</groupId> 
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
@RestController讲明是@Controller和@ResponseBody的合集,表示这是个控制器bean,并且是将函数的重返值直接填入HTTP响应体中,是REST风格的控制器。
@RequestMapping(“/test”)表示该控制器处理所有“/test”的URL请求,具体由特别函数处理,要遵照HTTP的措施来区分:GET表示查询、POST表示提交、PUT表示更新、DELETE表示删除。
Restful设计指南请参见:RESTFul Controller的角色,咱们可以观望,我这边将过多业务代码混淆在Controller的代码中。实际上,按照程序员必知此前端演进史一文所述Controller层应该做的事是:
处理请求的参数 渲染和重定向 接纳Model和Service处理Session和库克ies,我差不多认可那几个视角,最多再增长OAuth验证(利用拦截器实现即可)。而真正的事体逻辑应该单独分处一层来拍卖,即常见的service层;

 java代码:

 1 package yg.boot.action;
 2 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 3 import org.springframework.web.bind.annotation.RequestMapping;
 4 import org.springframework.web.bind.annotation.RestController;
 5 @RestController
 6 @EnableAutoConfiguration
 7 @RequestMapping("/test")
 8 public class AppController {    
 9     @RequestMapping("/sayhello")
10     public String sayHello(){
11         return "Hello World!";
12     }
13 }

4.Spring Boot启动  

 
@SpringBootApplication是其一注脚是该应用程序入口的标志,然后有了然的main函数,通过SpringApplication.run(xxxApplication.class,
args)来运转Spring Boot应用。打开SpringBootApplication表明  
可以发现,它是由另外多少个类组合而成的:@Configuration

(等同于
spring中的xml配置文件,使用Java文件做安排可以检查项目安全)、@EnableAutoConfiguration(自动配置)、@ComponentScan(组件扫描,我们非凡熟识的,能够活动发现和装配一些Bean)

 
 pom文件里能够见见,org.postgresql这么些库起效用的范围是runtime,也就是说,当应用程序启动时,即便Spring
Boot在classpath下检测到org.postgresql的留存,会自行配置postgresql数据库连接。

Application.properties代码:

 1 # DataSource settings
 2 spring.datasource.url=jdbc:postgresql://localhost:5432/jcbk
 3 spring.datasource.username=jcbk
 4 spring.datasource.password=123456
 5 spring.datasource.driver-class-name=org.postgresql.Driver
 6 
 7 # Tomcat Server settings (ServerProperties)
 8 server.port= 9080
 9 server.address= 127.0.0.1
10 server.sessionTimeout= 30
11 server.contextPath= /
12 
13 # Tomcat specifics
14 tomcat.accessLogEnabled= false
15 tomcat.protocolHeader= x-forwarded-proto
16 tomcat.remoteIpHeader= x-forwarded-for
17 tomcat.basedir=
18 tomcat.backgroundProcessorDelay=30 \# secs

java代码:

 1 package yg.boot;
 2 import org.springframework.boot.SpringApplication;
 3 import org.springframework.boot.autoconfigure.SpringBootApplication;
 4 /**
 5  * Hello world!
 6  */
 7 @SpringBootApplication
 8 public class App {    
 9     public static void main(String[] args ){
10         SpringApplication.run(App.class,args);
11     }
12 }

一贯运行App后,结果如下图所示。启动后走访http://localhost:9080/test/sayhello,
输出 Hello World!,如下所示:

图片 12

5.档次打包

品种打包使用maven-jar-plugin插件即可,生成boot-0.0.1-SNAPSHOT.jar。spring-boot-maven-plugin插件将boot-0.0.1-SNAPSHOT.jar重命名为boot-0.0.1-SNAPSHOT.jar.original,然后生成新boot-0.0.1-SNAPSHOT.jar包,目录结构为:
+—yg
          boot
+—org
          springframework
              boot
                 loader
+—-lib
+—-META-INF
+—-application.properties

Meta-inf代码:

 1 Manifest-Version: 1.0
 2 Implementation-Vendor: Pivotal Software, Inc.
 3 Implementation-Title: Springboot
 4 Implementation-Version: 0.0.1-SNAPSHOT
 5 Implementation-Vendor-Id: ygnet
 6 Built-By: oy
 7 Build-Jdk: 1.7.0_45
 8 Class-Path: lib/spring-test-4.2.6.RELEASE.jar lib/spring-core-4.2.6.RE
 9  LEASE.jar lib/spring-boot-starter-web-1.3.5.RELEASE.jar lib/spring-bo
10  ot-starter-tomcat-1.3.5.RELEASE.jar lib/tomcat-embed-core-8.0.33.jar 
11  lib/tomcat-embed-el-8.0.33.jar lib/tomcat-embed-logging-juli-8.0.33.j
12  ar lib/tomcat-embed-websocket-8.0.33.jar lib/spring-boot-starter-vali
13  dation-1.3.5.RELEASE.jar lib/hibernate-validator-5.2.4.Final.jar lib/
14  validation-api-1.1.0.Final.jar lib/jboss-logging-3.3.0.Final.jar lib/
15  classmate-1.1.0.jar lib/jackson-databind-2.6.6.jar lib/jackson-annota
16  tions-2.6.6.jar lib/jackson-core-2.6.6.jar lib/spring-web-4.2.6.RELEA
17  SE.jar lib/spring-aop-4.2.6.RELEASE.jar lib/aopalliance-1.0.jar lib/s
18  pring-beans-4.2.6.RELEASE.jar lib/spring-context-4.2.6.RELEASE.jar li
19  b/spring-webmvc-4.2.6.RELEASE.jar lib/spring-expression-4.2.6.RELEASE
20  .jar lib/spring-boot-starter-1.3.5.RELEASE.jar lib/spring-boot-1.3.5.
21  RELEASE.jar lib/spring-boot-autoconfigure-1.3.5.RELEASE.jar lib/sprin
22  g-boot-starter-logging-1.3.5.RELEASE.jar lib/logback-classic-1.1.7.ja
23  r lib/logback-core-1.1.7.jar lib/slf4j-api-1.7.21.jar lib/jcl-over-sl
24  f4j-1.7.21.jar lib/jul-to-slf4j-1.7.21.jar lib/log4j-over-slf4j-1.7.2
25  1.jar lib/snakeyaml-1.16.jar lib/spring-boot-starter-jdbc-1.3.5.RELEA
26  SE.jar lib/tomcat-jdbc-8.0.33.jar lib/tomcat-juli-8.0.33.jar lib/spri
27  ng-jdbc-4.2.6.RELEASE.jar lib/spring-tx-4.2.6.RELEASE.jar lib/postgre
28  sql-9.4.1208.jre7.jar lib/spring-boot-starter-actuator-1.3.5.RELEASE.
29  jar lib/spring-boot-actuator-1.3.5.RELEASE.jar
30 Start-Class: yg.boot.App
31 Created-By: Apache Maven 3.0.4
32 Spring-Boot-Version: 1.3.5.RELEASE
33 Main-Class: org.springframework.boot.loader.JarLauncher
34 Archiver-Version: Plexus Archiver

 

 Start-Class为Spring boot启动类,Main-Class为main方法入口。

                                      END

 

Post Author: admin

发表评论

电子邮件地址不会被公开。 必填项已用*标注