Overview
En esta sección, puede identificar los cambios que podría necesitar realizar en su aplicación para actualizar su controlador a una nueva versión.
Antes de actualizar, realice las siguientes acciones:
Asegúrese de que la nueva versión sea compatible con las versiones de MongoDB Server a las que se conecta su aplicación y con el entorno de ejecución de Java (JRE) en el que se ejecuta. Consulte la Página de compatibilidad para esta información.
Aborde cualquier cambio importante entre la versión actual del controlador que utiliza su aplicación y la versión de actualización planificada en la sección Cambios importantes. Para obtener más información sobre los cambios de compatibilidad de versiones de MongoDB Server, consulte la sección Cambios de compatibilidad de versiones de Server.
Tip
Para minimizar la cantidad de cambios que su aplicación podría requerir al actualizar las versiones del controlador en el futuro, utilice el API estable.
Cambios radicales
Un cambio importante es una modificación en una convención o comportamiento de una versión específica del controlador que podría impedir que su aplicación funcione correctamente si no se soluciona antes de la actualización.
Los cambios importantes de esta sección se clasifican según la versión del controlador que los introdujo. Al actualizar las versiones del controlador, aborde todos los cambios importantes entre la versión actual y la de actualización. Por ejemplo, si actualiza el controlador4.0 de4.5 la versión 7600 a la 7800, aborde todos los cambios importantes de la versión posterior a la4.0 8000, incluidos los que aparecen en la versión4.5 8200.
Cambios importantes en la versión 5.5
El controlador ya no es compatible con la versión v de MongoDB Server.4.0 Para obtener más información sobre este cambio, consulte la sección "Cambios en la compatibilidad del servidor con la versión del controlador".5.5
Cambios importantes en la versión 5.2
El controlador ya no es compatible con la versión v de MongoDB Server.3.6 Para obtener más información sobre este cambio, consulte la sección "Cambios en la compatibilidad del servidor con la versión del controlador".5.2
Cambios importantes en la versión 5.0
Esta versión del controlador introduce los siguientes cambios importantes:
Introduce los siguientes cambios en el
ConnectionIdclase:El constructor
ConnectionIdahora acepta un valor de tipolongcomo segundo parámetro en lugar deint. De igual forma, ahora acepta un valor de tipoLongcomo tercer parámetro en lugar deInteger. Dado que este cambio rompe la compatibilidad binaria, recompile cualquier código existente que llame al constructorConnectionId.El método
withServerValue()ahora acepta un parámetro de tipolongen lugar deint. Este cambio rompe la compatibilidad binaria, por lo que debe recompilar cualquier código que llame al métodowithServerValue().El método
getServerValue()ahora devuelve un valor de tipoLongen lugar deInteger. De forma similar, el métodogetLocalValue()devuelve un valor de tipolongen lugar deint. Dado que este cambio rompe la compatibilidad entre el binario y el código fuente, actualice cualquier código fuente que utilice estos métodos y reconstruya su binario.
Reemplaza las siguientes anotaciones de registros del paquete
org.bson.codecs.record.annotationscon anotaciones del mismo nombre del paqueteorg.bson.codecs.pojo.annotations:BsonIdBsonPropertyBsonRepresentation
Se cambia el tipo de dato del parámetro de duración del tiempo de espera en los métodos
SocketSettings.Builder.connectTimeout()ySocketSettings.Builder.readTimeout(). El tipo de dato de este parámetro ahora eslongen lugar deint.En versiones anteriores, este parámetro era de tipo
intpara ambos métodos. Este cambio rompe la compatibilidad binaria y requiere recompilación, pero no cambios de código. Para ver un ejemplo que muestra cómo llamar aSocketSettingsmétodos, consulte el ejemplo de SocketSettings en la guía "Especificar la configuración de MongoClient".Elimina el método
Filters.eqFull(), disponible exclusivamente enBeta, que permitía construir un filtro de igualdad al realizar una búsqueda vectorial de MongoDB. Puede usar el métodoFilters.eq()al instanciar un tipoVectorSearchOptions, como se muestra en el siguiente código:VectorSearchOptions opts = vectorSearchOptions().filter(eq("x", 8));
Elimina la clase implícita
org.mongodb.scala.ObservableImplicits.ToSingleObservableVoid. Esto significa que el tipoorg.reactivestreams.Publisher[Void]ya no se convierte automáticamente aorg.mongodb.scala.SingleObservable[Void]. La API también exponeorg.mongodb.scala.Observable[Unit]en lugar deorg.mongodb.scala.Observable[Void].Para obtener más información, consulte el rasgo Observable en la documentación de la API de Scala.
Cambia la forma en que
ClusterSettingscalculaClusterConnectionMode, haciéndolo más consistente al usar el nombre del conjunto de réplicas especificado, independientemente de su configuración. Anteriormente, el nombre del conjunto de réplicas solo se tenía en cuenta si lo establecía la cadena de conexión.Por ejemplo, los dos ejemplos de código siguientes devuelven el valor
ClusterConnectionMode.MULTIPLE, mientras que anteriormente el segundo devolvíaClusterConnectionMode.SINGLE.ClusterSettings.builder() .applyConnectionString(new ConnectionString("mongodb://127.0.0.1:27017/?replicaSet=replset")) .build() .getMode() ClusterSettings.builder() .hosts(Collections.singletonList( new ServerAddress("127.0.0.1", 27017) )) .requiredReplicaSetName("replset") .build() .getMode() Cambia la forma en que los valores
BsonDecimal128responden a las llamadas de método, respondiendo de la misma manera que los valoresDecimal128. En particular,BsonDecimal128.isNumber()ahora devuelvetrueyBsonDecimal128.asNumber()devuelve el equivalenteBsonNumber.Elimina los métodos ServerAddress
getSocketAddress()getSocketAddresses()y.En lugar de
getSocketAddress(), utilice el método de instanciagetByName()dejava.net.InetAddress.En lugar de
getSocketAddresses(), utilice el método de instanciagetAllByName()dejava.net.InetAddress.Elimina los métodos UnixServerAddress
getSocketAddress()getUnixSocketAddress()y.En lugar
getUnixSocketAddress()de, construya una instancia de.jnr.unixsocket.UnixSocketAddressPase la ruta completa del archivo de socket UNIX al constructor. Por defecto, MongoDB crea un archivo de socket UNIX ubicado"/tmp/mongodb-27017.sock"en. Para obtener más informaciónUnixSocketAddresssobre, consulte la documentación de la API UnixSocketAddress.Elimina la interfaz
Parameterizable. En lugar de implementar esta interfaz en un tipoCodecpersonalizado, anule el métodoCodecProvider.get()en elCodecProviderdel códec si este está diseñado para un tipo parametrizado.Elimina el método
isSlaveOk()de las clasesReadPreferenceyTaggableReadPreference. Para comprobar si una preferencia de lectura permite leer desde un miembro secundario de un conjunto de réplicas, utilice los métodosisSecondaryOk()de estas clases.Elimina los
DBCollection.getStats()DBCollection.isCapped()métodos auxiliarescollStatsy del comando. En lugar de estos métodos, puede usar la$collStatsetapa de canalización de agregación. Para ver un ejemplo de cómo usar esta etapa de canalización, consulte Novedades en 4.11 para el controlador Java.Elimina las clases
MapCodecyIterableCodec. En lugar deMapCodec, useMapCodecProvider. En lugar deIterableCodec, useCollectionCodecProvideroIterableCodecProviderpara los tiposIterableque no sean tiposCollection.Elimina los métodos
sharded()ynonAtomic()de las clasesMapReducePublisheryMapReduceIterable.Elimina los siguientes métodos para su uso con índices
geoHaystack:Indexes.geoHaystack()IndexOptions.getBucketSize()IndexOptions.bucketSize()
En su lugar, puede usar la
$geoNearetapa de canalización de agregación o un operador de consulta geoespacial en un 2índice d. Para obtener más información, consulte la página Consultas geoespaciales del manual de MongoDB Server.Elimina la opción
oplogReplayde las operaciones de búsqueda. Esto incluye los siguientes métodos:DBCursor.oplogReplay()DBCollectionFindOptions.isOplogReplay()DBCollectionFindOptions.oplogReplay()FindPublisher.oplogReplay()FindIterable.oplogReplay()
Elimina los siguientes constructores
Exception:MongoBulkWriteException(BulkWriteResult, List<BulkWriteError>, WriteConcernError, ServerAddress)MongoCursorNotFoundException(long, ServerAddress)MongoQueryException(ServerAddress, int, String)MongoQueryException(ServerAddress, int, String, String)MongoQueryException(MongoCommandException)
Elimina las siguientes sobrecargas para el método
BulkWriteResult.acknowledged():acknowledged(Type, int, List<BulkWriteUpsert>)acknowledged(Type, int, Integer, List<BulkWriteUpsert>)acknowledged(int, int, int, Integer, List<BulkWriteUpsert>)
Elimina los siguientes constructores
ChangeStreamDocument:ChangeStreamDocument(String, BsonDocument, BsonDocument, BsonDocument, TDocument, TDocument, BsonDocument, ...)ChangeStreamDocument(String, BsonDocument, BsonDocument, BsonDocument, TDocument, BsonDocument, BsonTimestamp, ...)ChangeStreamDocument(OperationType, BsonDocument, BsonDocument, BsonDocument, TDocument, BsonDocument, BsonTimestamp, ...)
Elimina los siguientes constructores para eventos:
CommandEvent(RequestContext, int, ConnectionDescription, String)CommandEvent(int, ConnectionDescription, String)CommandEvent(RequestContext, long, int, ConnectionDescription, String)CommandFailedEvent(RequestContext, int, ConnectionDescription, String, long, Throwable)CommandFailedEvent(int, ConnectionDescription, String, long, Throwable)CommandStartedEvent(RequestContext, int, ConnectionDescription, String, String, BsonDocument)CommandStartedEvent(int, ConnectionDescription, String, String, BsonDocument)CommandSucceededEvent(RequestContext, int, ConnectionDescription, String, BsonDocument, long)CommandSucceededEvent(int, ConnectionDescription, String, BsonDocument, long)ConnectionCheckedInEvent(ConnectionId)ConnectionCheckedOutEvent(ConnectionId, long)ConnectionCheckedOutEvent(ConnectionId)ConnectionCheckOutFailedEvent(ServerId, long, Reason)ConnectionCheckOutFailedEvent(ServerId, Reason)ConnectionCheckOutStartedEvent(ServerId)ConnectionReadyEvent(ConnectionId)ServerHeartbeatFailedEvent(ConnectionId, long, Throwable)ServerHeartbeatSucceededEvent(ConnectionId, BsonDocument, long)
Elimina la opción
errorLabelsde la claseWriteConcernError. Esto incluye los métodosaddLabel()ygetErrorLabels(), así como el constructor que incluye un parámetroerrorLabels. En su lugar, puede usar las etiquetas de error incluidas en el objetoMongoExceptionque contiene elWriteConcernError.Elimina las siguientes clases del paquete
com.mongodb.event:ConnectionAddedEventConnectionPoolOpenedEventConnectionRemovedEventClusterListenerAdapterConnectionPoolListenerAdapterServerListenerAdapterServerMonitorListenerAdapter
Debido a estas eliminaciones, los siguientes métodos también se eliminaron de la interfaz
ConnectionPoolListener:connectionAddedconnectionPoolOpenedconnectionRemoved
Para obtener más información sobre el paquete de eventos, consulte la documentación del paquete com.mongodb.event
Añade compatibilidad con la nueva opción
authorizedCollectiondel comandolistCollections. Esto introduce un cambio binario crucial en los métodosMongoDatabase.listCollectionNames(), lo que significa que cualquier código que utilice estos métodos debe recompilarse. Este cambio no requiere modificaciones en el código fuente.Elimina los siguientes métodos y tipos relacionados con la interfaz Stream:
streamFactoryFactory()método deMongoClientSettings.Builder. Utilice el métodoMongoClientSettings.Builder.transportSettings()en su lugar.getStreamFactoryFactory()método deMongoClientSettings. Utilice el métodoMongoClientSettings.getTransportSettings()en su lugar.NettyStreamFactoryFactoryClase. UtiliceNettyTransportSettings, que puede ser creado porTransportSettings.nettyBuilder()y aplicado a través deMongoClientSettings.Builder.transportSettings().NettyStreamFactoryclaseAsynchronousSocketChannelStreamFactoryclaseAsynchronousSocketChannelStreamFactoryFactoryclaseBufferProviderinterfazSocketStreamFactoryclaseStreaminterfazStreamFactoryinterfazStreamFactoryFactoryinterfazTlsChannelStreamFactoryFactoryclase
Cambios importantes en la versión 4.8
El controlador deja de ofrecer compatibilidad con las versiones v y anteriores del servidor MongoDB.3.4 Para obtener más información sobre este cambio, consulte la sección 4.8 "Cambios en la compatibilidad con el servidor de la versión del controlador".
Debe agregar una dependencia explícita en el módulo
org.bson.codecs.recordsi su aplicación implementa el controlador en un contenedor OSGi y depende del controlador para codificar y decodificar registros Java.El
RecordCodec, implementado en la versión v4.6, deserializaba los POJO y las clases de registro especificados como parámetros de tipo de los camposListoMapde un registro como valoresDocumenten lugar de sus respectivas clases. Esta versión ahora los deserializa a los tipos de registro y POJO adecuados.Por ejemplo, las siguientes definiciones de clase de registro muestran un registro
Bookque contiene unListque recibe un parámetro de tipoChapter:public record Book(String title, List<Chapter> chapters) {} public record Chapter(Integer number, String text) {} A partir de esta versión, el códec deserializa los datos en las clases de registro
ListenChapteren lugar de valoresDocument.
Cambios importantes en la versión 4.7
La
setWindowFieldsAPI del generador ya no está en fase beta. El nuevo generador rompe la compatibilidad con binarios y código fuente. Consulte la documentación de la API de Agregados para obtener información sobre las nuevassetWindowFields()firmas de método.Si su aplicación utiliza este generador en una versión anterior a v4.7, actualice su código fuente para usar la nueva firma del método y reconstruya su binario.
Cambios importantes en la versión 4.2
La clase
ObjectIdy su camposerialVersionUIDse actualizaron para utilizar un nuevo formato que minimiza los problemas de compatibilidad de serialización entre diferentes versiones del controlador.Si una aplicación que utiliza esta versión o una posterior del controlador intenta realizar la serialización de objetos Java en cualquier objeto que contenga un
ObjectIdy que haya sido serializado por una versión anterior del controlador, Java arroja unInvalidClassException.Para obtener más información sobre la serialización de objetos Java, consulte la documentación de Java sobre objetos serializables.
Cambios importantes en la versión 4.0
Varias clases y métodos marcados como obsoletos en la versión 3.12 se eliminaron en esta versión.
Los métodos auxiliares de inserción devuelven un objeto de resultado de inserción en lugar de
void.Los métodos
toJson()enBsonDocument,Document, yDbObjectdevuelven un formato JSON relajado en lugar de un formato JSON estricto. Esto hace que los documentos JSON sean más legibles, pero puede dificultar la identificación de la información de tipo BSON, como la diferencia entre un entero de 32 bits y uno de 64 bits. Si tu aplicación depende del formato JSON estricto, utiliza el modo estricto al leer o escribir datos. Aprende a especificar el formato JSON en la API actual en la guía Formato de datos de documento: JSON extendido.La representación BSON predeterminada del valor
java.util.UUIDse cambió deJAVA_LEGACYaUNSPECIFIED. Las aplicaciones que almacenan o recuperan valores UUID deben especificar explícitamente qué representación usar. Puede especificar la representación en la propiedaduuidRepresentationdeMongoClientSettings.La representación UUID que especifique controla estrictamente cómo el controlador decodifica los UUID. En versiones anteriores del controlador, si se especificaba la representación
JAVA_LEGACY, este decodificaba los objetos binarios de los subtipos 3 y 4 como UUID. En la versión 4.0, la representaciónJAVA_LEGACYsolo funciona con el subtipo 3.Para obtener una lista de los miembros de la
UuidRepresentationenumeración, consulte la 4.0 documentación de la API v.El grupo de conexiones ya no restringe el número de subprocesos en cola de espera ni de tareas asincrónicas que requieren una conexión a MongoDB. La aplicación debería limitar las solicitudes según sea necesario en lugar de depender de que el controlador genere un
MongoWaitQueueFullException.El controlador ya no registra utilizando el paquete
java.util.logging(JUL) y solo admite el marco de registro SLF4J.Se eliminaron los controladores integrados y de Android. Si su aplicación depende de estos controladores, debe seguir usando una versión 3.x del controlador Java.
Los archivos JAR de Uber,
mongo-java-driverymongodb-driver, ya no se publican. Si su aplicación depende de uno de ellos, debe cambiar amongodb-driver-syncomongodb-driver-legacy, según la API que utilice. Asegúrese de eliminar los archivos JAR de Uber de sus dependencias.Las actualizaciones de varias clases introdujeron problemas de compatibilidad binaria, como el cambio en la firma de los métodos auxiliares de inserción. Recompila las clases que enlazan con el controlador con esta versión o posterior para garantizar su correcto funcionamiento.
Cambios de compatibilidad de versiones del servidor
Un cambio de compatibilidad de versión del servidor es una modificación al controlador Java de MongoDB que interrumpe el soporte para un conjunto de versiones del servidor MongoDB.
El controlador deja de brindar soporte para una versión de MongoDB Server una vez que alcanza el final de su vida útil (EOL).
Para obtener más información sobre el soporte de MongoDB para productos EOL, consulte la Política de soporte heredado.
Cambios en la compatibilidad del servidor con la versión del controlador 5.5
El5.5 controlador v deja de ser compatible con MongoDB Server.4.0 Para usar el5.5 controlador v, debe conectarse a MongoDB Server 4.2 o posterior. Para saber cómo actualizar su implementación de MongoDB Server, consulte las Notas de la versión en el manual de MongoDB Server.
Cambios en la compatibilidad del servidor con la versión del controlador 5.2
El5.2 controlador v deja de ser compatible con MongoDB Server.3.6 Para usar el5.2 controlador v, debe conectarse a MongoDB Server 4.0 o posterior. Para saber cómo actualizar su implementación de MongoDB Server, consulte las Notas de la versión en el manual de MongoDB Server.
Cambios en la compatibilidad del servidor con la versión del controlador 4.8
El4.8 controlador v ya no es compatible con MongoDB Server 3.4 y versiones anteriores. Para usar el4.8 controlador v, debe conectarse a MongoDB Server 3.6 o versiones posteriores. Para saber cómo actualizar su implementación de MongoDB Server, consulte las Notas de la versión en el manual de MongoDB Server.
Cambios de compatibilidad con la versión del controlador 3.x
Las versiones 3.x del controlador Java no pueden conectarse a MongoDB Server v8.1. A partir de MongoDB Server v8.1, el comando buildinfo requiere autenticación, lo que provoca una incompatibilidad con el controlador v3.x.